shotstack 0.2.2 → 0.2.6

data/lib/shotstack/models/audio_asset.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -28,6 +28,9 @@ module Shotstack
     # Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
     attr_accessor :volume
 
+    # Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to  adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).
+    attr_accessor :speed
+
     # The effect to apply to the audio asset <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
 
@@ -60,6 +63,7 @@ module Shotstack
         :'src' => :'src',
         :'trim' => :'trim',
         :'volume' => :'volume',
+        :'speed' => :'speed',
         :'effect' => :'effect'
       }
     end
@@ -76,6 +80,7 @@ module Shotstack
         :'src' => :'String',
         :'trim' => :'Float',
         :'volume' => :'Float',
+        :'speed' => :'Float',
         :'effect' => :'String'
       }
     end
@@ -109,6 +114,8 @@ module Shotstack
 
       if attributes.key?(:'src')
         self.src = attributes[:'src']
+      else
+        self.src = nil
       end
 
       if attributes.key?(:'trim')
@@ -119,6 +126,10 @@ module Shotstack
         self.volume = attributes[:'volume']
       end
 
+      if attributes.key?(:'speed')
+        self.speed = attributes[:'speed']
+      end
+
       if attributes.key?(:'effect')
         self.effect = attributes[:'effect']
       end
@@ -127,6 +138,7 @@ module Shotstack
     # 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.')
@@ -136,19 +148,48 @@ module Shotstack
         invalid_properties.push('invalid value for "src", src cannot be nil.')
       end
 
+      if !@speed.nil? && @speed > 10
+        invalid_properties.push('invalid value for "speed", must be smaller than or equal to 10.')
+      end
+
+      if !@speed.nil? && @speed < 0
+        invalid_properties.push('invalid value for "speed", must be greater than or equal to 0.')
+      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?
       return false if @src.nil?
+      return false if !@speed.nil? && @speed > 10
+      return false if !@speed.nil? && @speed < 0
       effect_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
       return false unless effect_validator.valid?(@effect)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] speed Value to be assigned
+    def speed=(speed)
+      if speed.nil?
+        fail ArgumentError, 'speed cannot be nil'
+      end
+
+      if speed > 10
+        fail ArgumentError, 'invalid value for "speed", must be smaller than or equal to 10.'
+      end
+
+      if speed < 0
+        fail ArgumentError, 'invalid value for "speed", must be greater than or equal to 0.'
+      end
+
+      @speed = speed
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] effect Object to be assigned
     def effect=(effect)
@@ -168,6 +209,7 @@ module Shotstack
           src == o.src &&
           trim == o.trim &&
           volume == o.volume &&
+          speed == o.speed &&
           effect == o.effect
     end
 
@@ -180,43 +222,37 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, src, trim, volume, effect].hash
+      [type, src, trim, volume, speed, effect].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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -251,7 +287,7 @@ module Shotstack
       else # model
         # 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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/shotstack/models/audio_enhancement.rb

@@ -0,0 +1,43 @@
+=begin
+#Shotstack
+
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shotstack
+  # An audio enhancement that can be applied to the audio content of a rendition. The following providers are available: <ul>   <li><a href=\"#tocs_dolbyenhancement\">DolbyEnhancement</a></li> </ul>
+  module AudioEnhancement
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'DolbyEnhancement'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'enhancement'
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+        Shotstack.const_get(discriminator_value).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/shotstack/models/clip.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -40,7 +40,7 @@ module Shotstack
     # A motion effect to apply to the Clip. <ul>   <li>`zoomIn` - slow zoom in</li>   <li>`zoomOut` - slow zoom out</li>   <li>`slideLeft` - slow slide (pan) left</li>   <li>`slideRight` - slow slide (pan) right</li>   <li>`slideUp` - slow slide (pan) up</li>   <li>`slideDown` - slow slide (pan) down</li> </ul> The motion effect speed can also be controlled by appending `Fast` or `Slow` to the effect, e.g. `zoomInFast` or `slideRightSlow`.
     attr_accessor :effect
 
-    # A filter effect to apply to the Clip. <ul>   <li>`boost` - boost contrast and saturation</li>   <li>`contrast` - increase contrast</li>   <li>`darken` - darken the scene</li>   <li>`greyscale` - remove colour</li>   <li>`lighten` - lighten the scene</li>   <li>`muted` - reduce saturation and contrast</li>   <li>`negative` - negative colors</li> </ul>
+    # A filter effect to apply to the Clip. <ul>   <li>`blur` - blur the scene</li>   <li>`boost` - boost contrast and saturation</li>   <li>`contrast` - increase contrast</li>   <li>`darken` - darken the scene</li>   <li>`greyscale` - remove colour</li>   <li>`lighten` - lighten the scene</li>   <li>`muted` - reduce saturation and contrast</li>   <li>`negative` - negative colors</li> </ul>
     attr_accessor :filter
 
     # Sets the opacity of the Clip where 1 is opaque and 0 is transparent.
@@ -134,14 +134,20 @@ module Shotstack
 
       if attributes.key?(:'asset')
         self.asset = attributes[:'asset']
+      else
+        self.asset = nil
       end
 
       if attributes.key?(:'start')
         self.start = attributes[:'start']
+      else
+        self.start = nil
       end
 
       if attributes.key?(:'length')
         self.length = attributes[:'length']
+      else
+        self.length = nil
       end
 
       if attributes.key?(:'fit')
@@ -184,6 +190,7 @@ module Shotstack
     # 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 @asset.nil?
         invalid_properties.push('invalid value for "asset", asset cannot be nil.')
@@ -203,6 +210,7 @@ module Shotstack
     # 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 @asset.nil?
       return false if @start.nil?
       return false if @length.nil?
@@ -210,9 +218,9 @@ module Shotstack
       return false unless fit_validator.valid?(@fit)
       position_validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"])
       return false unless position_validator.valid?(@position)
-      effect_validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomInSlow", "zoomInFast", "zoomOut", "zoomOutSlow", "zoomOutFast", "slideLeft", "slideLeftSLow", "slideLeftFast", "slideRight", "slideRightSlow", "slideRightFast", "slideUp", "slideUpSlow", "slideUpFast", "slideDown", "slideDownSlow", "slideDownFast"])
+      effect_validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomInSlow", "zoomInFast", "zoomOut", "zoomOutSlow", "zoomOutFast", "slideLeft", "slideLeftSlow", "slideLeftFast", "slideRight", "slideRightSlow", "slideRightFast", "slideUp", "slideUpSlow", "slideUpFast", "slideDown", "slideDownSlow", "slideDownFast"])
       return false unless effect_validator.valid?(@effect)
-      filter_validator = EnumAttributeValidator.new('String', ["boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
+      filter_validator = EnumAttributeValidator.new('String', ["blur", "boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
       return false unless filter_validator.valid?(@filter)
       true
     end
@@ -240,7 +248,7 @@ module Shotstack
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] effect Object to be assigned
     def effect=(effect)
-      validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomInSlow", "zoomInFast", "zoomOut", "zoomOutSlow", "zoomOutFast", "slideLeft", "slideLeftSLow", "slideLeftFast", "slideRight", "slideRightSlow", "slideRightFast", "slideUp", "slideUpSlow", "slideUpFast", "slideDown", "slideDownSlow", "slideDownFast"])
+      validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomInSlow", "zoomInFast", "zoomOut", "zoomOutSlow", "zoomOutFast", "slideLeft", "slideLeftSlow", "slideLeftFast", "slideRight", "slideRightSlow", "slideRightFast", "slideUp", "slideUpSlow", "slideUpFast", "slideDown", "slideDownSlow", "slideDownFast"])
       unless validator.valid?(effect)
         fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}."
       end
@@ -250,7 +258,7 @@ module Shotstack
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] filter Object to be assigned
     def filter=(filter)
-      validator = EnumAttributeValidator.new('String', ["boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
+      validator = EnumAttributeValidator.new('String', ["blur", "boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
       unless validator.valid?(filter)
         fail ArgumentError, "invalid value for \"filter\", must be one of #{validator.allowable_values}."
       end
@@ -292,36 +300,30 @@ module Shotstack
     # @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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -356,7 +358,7 @@ module Shotstack
       else # model
         # 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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/shotstack/models/crop.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -94,6 +94,7 @@ module Shotstack
     # 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 !@top.nil? && @top > 1
         invalid_properties.push('invalid value for "top", must be smaller than or equal to 1.')
@@ -133,6 +134,7 @@ module Shotstack
     # 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 !@top.nil? && @top > 1
       return false if !@top.nil? && @top < 0
       return false if !@bottom.nil? && @bottom > 1
@@ -147,11 +149,15 @@ module Shotstack
     # Custom attribute writer method with validation
     # @param [Object] top Value to be assigned
     def top=(top)
-      if !top.nil? && top > 1
+      if top.nil?
+        fail ArgumentError, 'top cannot be nil'
+      end
+
+      if top > 1
         fail ArgumentError, 'invalid value for "top", must be smaller than or equal to 1.'
       end
 
-      if !top.nil? && top < 0
+      if top < 0
         fail ArgumentError, 'invalid value for "top", must be greater than or equal to 0.'
       end
 
@@ -161,11 +167,15 @@ module Shotstack
     # Custom attribute writer method with validation
     # @param [Object] bottom Value to be assigned
     def bottom=(bottom)
-      if !bottom.nil? && bottom > 1
+      if bottom.nil?
+        fail ArgumentError, 'bottom cannot be nil'
+      end
+
+      if bottom > 1
         fail ArgumentError, 'invalid value for "bottom", must be smaller than or equal to 1.'
       end
 
-      if !bottom.nil? && bottom < 0
+      if bottom < 0
         fail ArgumentError, 'invalid value for "bottom", must be greater than or equal to 0.'
       end
 
@@ -175,11 +185,15 @@ module Shotstack
     # Custom attribute writer method with validation
     # @param [Object] left Value to be assigned
     def left=(left)
-      if !left.nil? && left > 1
+      if left.nil?
+        fail ArgumentError, 'left cannot be nil'
+      end
+
+      if left > 1
         fail ArgumentError, 'invalid value for "left", must be smaller than or equal to 1.'
       end
 
-      if !left.nil? && left < 0
+      if left < 0
         fail ArgumentError, 'invalid value for "left", must be greater than or equal to 0.'
       end
 
@@ -189,11 +203,15 @@ module Shotstack
     # Custom attribute writer method with validation
     # @param [Object] right Value to be assigned
     def right=(right)
-      if !right.nil? && right > 1
+      if right.nil?
+        fail ArgumentError, 'right cannot be nil'
+      end
+
+      if right > 1
         fail ArgumentError, 'invalid value for "right", must be smaller than or equal to 1.'
       end
 
-      if !right.nil? && right < 0
+      if right < 0
         fail ArgumentError, 'invalid value for "right", must be greater than or equal to 0.'
       end
 
@@ -227,36 +245,30 @@ module Shotstack
     # @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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -291,7 +303,7 @@ module Shotstack
       else # model
         # 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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end