shotstack 0.1.1 → 0.1.6

data/lib/shotstack/models/audio_asset.rb

@@ -1,22 +1,23 @@
 =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'
 require_relative 'asset'
 
 module Shotstack
   # The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such  as an mp3 file.
   class AudioAsset < Asset
-    # The type of asset - set to <b>audio</b> for audio assets.
+    # The type of asset - set to `audio` for audio assets.
     attr_accessor :type
 
     # The audio source URL. The URL must be publicly accessible or include credentials.
@@ -28,23 +29,55 @@ 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
 
+    # 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
+
+    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',
         :'src' => :'src',
         :'trim' => :'trim',
-        :'volume' => :'volume'
+        :'volume' => :'volume',
+        :'effect' => :'effect'
       }
     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
       {
         :'type' => :'String',
         :'src' => :'String',
         :'trim' => :'Float',
-        :'volume' => :'Float'
+        :'volume' => :'Float',
+        :'effect' => :'String'
       }
     end
 
@@ -85,6 +118,12 @@ module Shotstack
 
       if attributes.key?(:'volume')
         self.volume = attributes[:'volume']
+      else
+        self.volume = 1
+      end
+
+      if attributes.key?(:'effect')
+        self.effect = attributes[:'effect']
       end
     end
 
@@ -108,9 +147,21 @@ module Shotstack
     def valid?
       return false if @type.nil?
       return false if @src.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)
@@ -119,7 +170,8 @@ module Shotstack
           type == o.type &&
           src == o.src &&
           trim == o.trim &&
-          volume == o.volume
+          volume == o.volume &&
+          effect == o.effect
     end
 
     # @see the `==` method
@@ -131,7 +183,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, src, trim, volume].hash
+      [type, src, trim, volume, effect].hash
     end
 
     # Builds the object from hash
@@ -147,7 +199,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)
@@ -155,7 +209,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
@@ -167,8 +221,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
@@ -198,7 +252,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
 
@@ -224,7 +280,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
@@ -247,5 +303,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/clip.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 clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it.
@@ -30,17 +31,17 @@ module Shotstack
     # Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and  scaling images such as logos and watermarks.
     attr_accessor :scale
 
-    # Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position.
+    # Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
     attr_accessor :position
 
     attr_accessor :offset
 
     attr_accessor :transition
 
-    # A motion effect to apply to the Clip.
+    # 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>
     attr_accessor :effect
 
-    # A filter effect to apply to the Clip.
+    # 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>`invert` - invert colors</li> </ul>
     attr_accessor :filter
 
     # Sets the opacity of the Clip where 1 is opaque and 0 is transparent.
@@ -85,6 +86,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
       {
@@ -169,6 +175,8 @@ module Shotstack
 
       if attributes.key?(:'opacity')
         self.opacity = attributes[:'opacity']
+      else
+        self.opacity = 1
       end
     end
 
@@ -291,7 +299,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)
@@ -299,7 +309,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
@@ -311,8 +321,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
@@ -342,7 +352,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
 
@@ -368,7 +380,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
@@ -391,5 +403,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/crop.rb

@@ -0,0 +1,346 @@
+=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 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: 5.0.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shotstack
+  # Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop  of 0.25 will crop the top by quarter of the asset.
+  class Crop
+    # Crop from the top of the asset
+    attr_accessor :top
+
+    # Crop from the bottom of the asset
+    attr_accessor :bottom
+
+    # Crop from the left of the asset
+    attr_accessor :left
+
+    # Crop from the left of the asset
+    attr_accessor :right
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'top' => :'top',
+        :'bottom' => :'bottom',
+        :'left' => :'left',
+        :'right' => :'right'
+      }
+    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
+      {
+        :'top' => :'Float',
+        :'bottom' => :'Float',
+        :'left' => :'Float',
+        :'right' => :'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::Crop` 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::Crop`. 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?(:'top')
+        self.top = attributes[:'top']
+      end
+
+      if attributes.key?(:'bottom')
+        self.bottom = attributes[:'bottom']
+      end
+
+      if attributes.key?(:'left')
+        self.left = attributes[:'left']
+      end
+
+      if attributes.key?(:'right')
+        self.right = attributes[:'right']
+      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 !@top.nil? && @top > 1
+        invalid_properties.push('invalid value for "top", must be smaller than or equal to 1.')
+      end
+
+      if !@top.nil? && @top < 0
+        invalid_properties.push('invalid value for "top", must be greater than or equal to 0.')
+      end
+
+      if !@bottom.nil? && @bottom > 1
+        invalid_properties.push('invalid value for "bottom", must be smaller than or equal to 1.')
+      end
+
+      if !@bottom.nil? && @bottom < 0
+        invalid_properties.push('invalid value for "bottom", must be greater than or equal to 0.')
+      end
+
+      if !@left.nil? && @left > 1
+        invalid_properties.push('invalid value for "left", must be smaller than or equal to 1.')
+      end
+
+      if !@left.nil? && @left < 0
+        invalid_properties.push('invalid value for "left", must be greater than or equal to 0.')
+      end
+
+      if !@right.nil? && @right > 1
+        invalid_properties.push('invalid value for "right", must be smaller than or equal to 1.')
+      end
+
+      if !@right.nil? && @right < 0
+        invalid_properties.push('invalid value for "right", 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?
+      return false if !@top.nil? && @top > 1
+      return false if !@top.nil? && @top < 0
+      return false if !@bottom.nil? && @bottom > 1
+      return false if !@bottom.nil? && @bottom < 0
+      return false if !@left.nil? && @left > 1
+      return false if !@left.nil? && @left < 0
+      return false if !@right.nil? && @right > 1
+      return false if !@right.nil? && @right < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] top Value to be assigned
+    def top=(top)
+      if !top.nil? && top > 1
+        fail ArgumentError, 'invalid value for "top", must be smaller than or equal to 1.'
+      end
+
+      if !top.nil? && top < 0
+        fail ArgumentError, 'invalid value for "top", must be greater than or equal to 0.'
+      end
+
+      @top = top
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bottom Value to be assigned
+    def bottom=(bottom)
+      if !bottom.nil? && bottom > 1
+        fail ArgumentError, 'invalid value for "bottom", must be smaller than or equal to 1.'
+      end
+
+      if !bottom.nil? && bottom < 0
+        fail ArgumentError, 'invalid value for "bottom", must be greater than or equal to 0.'
+      end
+
+      @bottom = bottom
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] left Value to be assigned
+    def left=(left)
+      if !left.nil? && left > 1
+        fail ArgumentError, 'invalid value for "left", must be smaller than or equal to 1.'
+      end
+
+      if !left.nil? && left < 0
+        fail ArgumentError, 'invalid value for "left", must be greater than or equal to 0.'
+      end
+
+      @left = left
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] right Value to be assigned
+    def right=(right)
+      if !right.nil? && right > 1
+        fail ArgumentError, 'invalid value for "right", must be smaller than or equal to 1.'
+      end
+
+      if !right.nil? && right < 0
+        fail ArgumentError, 'invalid value for "right", must be greater than or equal to 0.'
+      end
+
+      @right = right
+    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 &&
+          top == o.top &&
+          bottom == o.bottom &&
+          left == o.left &&
+          right == o.right
+    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
+      [top, bottom, left, right].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)
+        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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      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 :Time
+        Time.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
+        # 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
+
+    # 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