shotstack 0.0.9 → 0.1.2

data/lib/shotstack/models/offset.rb

@@ -0,0 +1,266 @@
+=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
+  # Offsets the position of an asset horizontally or vertically by a relative distance.
+  class Offset
+    # Offset an asset on the horizontal axis (left or right), range varies from -1 to 1. Positive numbers move the asset right, negative left. For all assets except titles the distance moved is relative to the width  of the viewport - i.e. an X offset of 0.5 will move the asset half the  screen width to the right.
+    attr_accessor :x
+
+    # Offset an asset on the vertical axis (up or down), range varies from -1 to 1. Positive numbers move the asset up, negative down. For all assets except titles the distance moved is relative to the height  of the viewport - i.e. an Y offset of 0.5 will move the asset up half the  screen height.
+    attr_accessor :y
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'x' => :'x',
+        :'y' => :'y'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'x' => :'Float',
+        :'y' => :'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::Offset` 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::Offset`. 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?(:'x')
+        self.x = attributes[:'x']
+      end
+
+      if attributes.key?(:'y')
+        self.y = attributes[:'y']
+      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 !@x.nil? && @x > 1
+        invalid_properties.push('invalid value for "x", must be smaller than or equal to 1.')
+      end
+
+      if !@x.nil? && @x < -1
+        invalid_properties.push('invalid value for "x", must be greater than or equal to -1.')
+      end
+
+      if !@y.nil? && @y > 1
+        invalid_properties.push('invalid value for "y", must be smaller than or equal to 1.')
+      end
+
+      if !@y.nil? && @y < -1
+        invalid_properties.push('invalid value for "y", must be greater than or equal to -1.')
+      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 !@x.nil? && @x > 1
+      return false if !@x.nil? && @x < -1
+      return false if !@y.nil? && @y > 1
+      return false if !@y.nil? && @y < -1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] x Value to be assigned
+    def x=(x)
+      if !x.nil? && x > 1
+        fail ArgumentError, 'invalid value for "x", must be smaller than or equal to 1.'
+      end
+
+      if !x.nil? && x < -1
+        fail ArgumentError, 'invalid value for "x", must be greater than or equal to -1.'
+      end
+
+      @x = x
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] y Value to be assigned
+    def y=(y)
+      if !y.nil? && y > 1
+        fail ArgumentError, 'invalid value for "y", must be smaller than or equal to 1.'
+      end
+
+      if !y.nil? && y < -1
+        fail ArgumentError, 'invalid value for "y", must be greater than or equal to -1.'
+      end
+
+      @y = y
+    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 &&
+          x == o.x &&
+          y == o.y
+    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
+      [x, y].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

data/lib/shotstack/models/output.rb

@@ -1,105 +1,255 @@
+=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
-  # Model for Output
+  # The video output format.
   class Output
+    # `mp4`, `webm` video or animated `gif`
     attr_accessor :format
 
+    # The output resolution of the video. <ul>   <li>`preview` - 512px x 288px @ 15fps</li>   <li>`mobile` - 640px x 360px @ 25fps</li>   <li>`sd` - 1024px x 576px @ 25fps</li>   <li>`hd` - 1280px x 720px @ 25fps</li>   <li>`1080` - 1920px x 1080px @ 25fps</li> </ul>
     attr_accessor :resolution
 
+    # The aspect ratio (shape) of the video. Useful for social media sites. Options are: <ul>   <li>`16:9` - regular landscape/horizontal aspect ratio (default)</li>   <li>`9:16` - vertical/portrait aspect ratio.</li>   <li>`1:1` - square aspect ratio.</li> </ul>
+    attr_accessor :aspect_ratio
+
+    # Override the resolution and scale the video to render at a different size. When using scaleTo the video should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the video at SD and the text will be scaled to the correct size. This is useful if you want to create multiple video sizes. <ul>   <li>`preview` - 512px x 288px @ 15fps</li>   <li>`mobile` - 640px x 360px @ 25fps</li>   <li>`sd` - 1024px x 576px @25fps</li>   <li>`hd` - 1280px x 720px @25fps</li>   <li>`1080` - 1920px x 1080px @25fps</li> </ul>
+    attr_accessor :scale_to
+
+    attr_accessor :poster
+
+    attr_accessor :thumbnail
+
+    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
       {
-        
         :'format' => :'format',
-        
-        :'resolution' => :'resolution'
-        
+        :'resolution' => :'resolution',
+        :'aspect_ratio' => :'aspectRatio',
+        :'scale_to' => :'scaleTo',
+        :'poster' => :'poster',
+        :'thumbnail' => :'thumbnail'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'format' => :'String',
-        :'resolution' => :'String'
-        
+        :'resolution' => :'String',
+        :'aspect_ratio' => :'String',
+        :'scale_to' => :'String',
+        :'poster' => :'Poster',
+        :'thumbnail' => :'Thumbnail'
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Output` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      # 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::Output`. 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[:'format']
+      if attributes.key?(:'format')
         self.format = attributes[:'format']
       end
-      
-      if attributes[:'resolution']
+
+      if attributes.key?(:'resolution')
         self.resolution = attributes[:'resolution']
       end
-      
+
+      if attributes.key?(:'aspect_ratio')
+        self.aspect_ratio = attributes[:'aspect_ratio']
+      end
+
+      if attributes.key?(:'scale_to')
+        self.scale_to = attributes[:'scale_to']
+      end
+
+      if attributes.key?(:'poster')
+        self.poster = attributes[:'poster']
+      end
+
+      if attributes.key?(:'thumbnail')
+        self.thumbnail = attributes[:'thumbnail']
+      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 @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      if @resolution.nil?
+        invalid_properties.push('invalid value for "resolution", resolution 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 @format.nil?
+      format_validator = EnumAttributeValidator.new('String', ["mp4", "webm", "gif"])
+      return false unless format_validator.valid?(@format)
+      return false if @resolution.nil?
+      resolution_validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080"])
+      return false unless resolution_validator.valid?(@resolution)
+      aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "9:16", "1:1"])
+      return false unless aspect_ratio_validator.valid?(@aspect_ratio)
+      scale_to_validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080"])
+      return false unless scale_to_validator.valid?(@scale_to)
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] format Object to be assigned
     def format=(format)
-      allowed_values = ["mp4", "gif"]
-      if format && !allowed_values.include?(format)
-        fail "invalid value for 'format', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["mp4", "webm", "gif"])
+      unless validator.valid?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
       end
       @format = format
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] resolution Object to be assigned
     def resolution=(resolution)
-      allowed_values = ["preview", "mobile", "sd", "hd", "1080"]
-      if resolution && !allowed_values.include?(resolution)
-        fail "invalid value for 'resolution', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080"])
+      unless validator.valid?(resolution)
+        fail ArgumentError, "invalid value for \"resolution\", must be one of #{validator.allowable_values}."
       end
       @resolution = resolution
     end
 
-    # Check equality by comparing each attribute.
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] aspect_ratio Object to be assigned
+    def aspect_ratio=(aspect_ratio)
+      validator = EnumAttributeValidator.new('String', ["16:9", "9:16", "1:1"])
+      unless validator.valid?(aspect_ratio)
+        fail ArgumentError, "invalid value for \"aspect_ratio\", must be one of #{validator.allowable_values}."
+      end
+      @aspect_ratio = aspect_ratio
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scale_to Object to be assigned
+    def scale_to=(scale_to)
+      validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080"])
+      unless validator.valid?(scale_to)
+        fail ArgumentError, "invalid value for \"scale_to\", must be one of #{validator.allowable_values}."
+      end
+      @scale_to = scale_to
+    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 &&
           format == o.format &&
-          resolution == o.resolution
+          resolution == o.resolution &&
+          aspect_ratio == o.aspect_ratio &&
+          scale_to == o.scale_to &&
+          poster == o.poster &&
+          thumbnail == o.thumbnail
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
     def hash
-      [format, resolution].hash
+      [format, resolution, aspect_ratio, scale_to, poster, thumbnail].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
 
-    # build the object from hash
+    # 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.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
+      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) } )
-          else
-            #TODO show warning in debug mode
+            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]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        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
@@ -112,16 +262,19 @@ module Shotstack
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
-        if value =~ /^(true|t|yes|y|1)$/i
+      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/
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
         k_type = Regexp.last_match[:k_type]
         v_type = Regexp.last_match[:v_type]
         {}.tap do |hash|
@@ -130,36 +283,45 @@ module Shotstack
           end
         end
       else # model
-        _model = Shotstack.const_get(type).new
-        _model.build_from_hash(value)
+        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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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)
-        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
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -170,6 +332,5 @@ module Shotstack
         value
       end
     end
-
   end
 end