shotstack 0.1.1 → 0.1.6

data/lib/shotstack/models/render_response.rb

@@ -1,21 +1,24 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
 require 'date'
+require 'time'
 
 module Shotstack
   class RenderResponse
+    # `true` if status available, else `false`.
     attr_accessor :success
 
+    # `OK` or an error message.
     attr_accessor :message
 
     attr_accessor :response
@@ -29,6 +32,11 @@ module Shotstack
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -135,7 +143,9 @@ module Shotstack
     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
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
@@ -143,7 +153,7 @@ module Shotstack
           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
       end
 
       self
@@ -155,8 +165,8 @@ module Shotstack
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -186,7 +196,9 @@ module Shotstack
           end
         end
       else # model
-        Shotstack.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = Shotstack.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -212,7 +224,7 @@ module Shotstack
           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
@@ -235,5 +247,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/render_response_data.rb

@@ -1,37 +1,56 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
 require 'date'
+require 'time'
 
 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
@@ -59,23 +78,40 @@ 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'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # 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'
@@ -103,10 +139,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
@@ -115,10 +147,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
@@ -136,10 +196,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
@@ -148,6 +204,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
@@ -166,11 +226,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?
@@ -192,10 +252,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
@@ -210,7 +276,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, id, owner, url, 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
@@ -226,7 +292,9 @@ module Shotstack
     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
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
@@ -234,7 +302,7 @@ module Shotstack
           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
       end
 
       self
@@ -246,8 +314,8 @@ module Shotstack
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -277,7 +345,9 @@ module Shotstack
           end
         end
       else # model
-        Shotstack.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = Shotstack.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -303,7 +373,7 @@ module Shotstack
           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
@@ -326,5 +396,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/soundtrack.rb

@@ -1,16 +1,17 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
 require 'date'
+require 'time'
 
 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.
@@ -18,7 +19,7 @@ module Shotstack
     # 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).
@@ -55,6 +56,11 @@ module Shotstack
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -95,6 +101,8 @@ module Shotstack
 
       if attributes.key?(:'volume')
         self.volume = attributes[:'volume']
+      else
+        self.volume = 1
       end
     end
 
@@ -163,7 +171,9 @@ module Shotstack
     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
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
@@ -171,7 +181,7 @@ module Shotstack
           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
       end
 
       self
@@ -183,8 +193,8 @@ module Shotstack
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -214,7 +224,9 @@ module Shotstack
           end
         end
       else # model
-        Shotstack.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = Shotstack.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -240,7 +252,7 @@ module Shotstack
           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
@@ -263,5 +275,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end