shotstack 0.0.11 → 0.1.4

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

data/lib/shotstack/models/timeline.rb

@@ -1,26 +1,29 @@
 =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
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0
+OpenAPI Generator version: 4.2.1
 
 =end
 
 require 'date'
 
 module Shotstack
-  # A timeline represents the contents of a video edit over time, in seconds. A timeline consists of layers called tracks. Tracks are composed of titles, images or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time. 
+  # A timeline represents the contents of a video edit over time, in seconds. A timeline consists of layers called tracks. Tracks are composed of titles, images or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time.
   class Timeline
     attr_accessor :soundtrack
 
-    # A hexidecimal value for the timeline background colour. Defaults to black (#000000). 
+    # A hexadecimal value for the timeline background colour. Defaults to #000000 (black).
     attr_accessor :background
 
-    # A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images. 
+    # An array of custom fonts to be downloaded for use by the HTML assets.
+    attr_accessor :fonts
+
+    # A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.
     attr_accessor :tracks
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,6 +31,7 @@ module Shotstack
       {
         :'soundtrack' => :'soundtrack',
         :'background' => :'background',
+        :'fonts' => :'fonts',
         :'tracks' => :'tracks'
       }
     end
@@ -37,10 +41,17 @@ module Shotstack
       {
         :'soundtrack' => :'Soundtrack',
         :'background' => :'String',
+        :'fonts' => :'Array<Font>',
         :'tracks' => :'Array<Track>'
       }
     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 = {})
@@ -62,6 +73,14 @@ module Shotstack
 
       if attributes.key?(:'background')
         self.background = attributes[:'background']
+      else
+        self.background = '#000000'
+      end
+
+      if attributes.key?(:'fonts')
+        if (value = attributes[:'fonts']).is_a?(Array)
+          self.fonts = value
+        end
       end
 
       if attributes.key?(:'tracks')
@@ -96,6 +115,7 @@ module Shotstack
       self.class == o.class &&
           soundtrack == o.soundtrack &&
           background == o.background &&
+          fonts == o.fonts &&
           tracks == o.tracks
     end
 
@@ -108,7 +128,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [soundtrack, background, tracks].hash
+      [soundtrack, background, fonts, tracks].hash
     end
 
     # Builds the object from hash
@@ -197,7 +217,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/title_asset.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
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -14,20 +14,31 @@ require 'date'
 require_relative 'asset'
 
 module Shotstack
-  # The TitleAsset clip type lets you create video titles from a text string and apply styling.
+  # The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
   class TitleAsset < Asset
-    # The type of asset - set to <b>title</b> for titles.
+    # The type of asset - set to `title` for titles.
     attr_accessor :type
 
     # The title text string - i.e. \"My Title\".
     attr_accessor :text
 
-    # Uses a preset to apply font properties and stylng to the title. 
+    # Uses a preset to apply font properties and styling to the title. <ul>   <li>`minimal`</li>   <li>`blockbuster`</li>   <li>`vogue`</li>   <li>`sketchy`</li>   <li>`skinny`</li>   <li>`chunk`</li>   <li>`chunkLight`</li>   <li>`marker`</li>   <li>`future`</li>   <li>`subtitle`</li> </ul>
     attr_accessor :style
 
-    # Place the title in one of nine predefined positions of the viewport. 
+    # Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with  50% transparency.
+    attr_accessor :color
+
+    # Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul>   <li>`xx-small`</li>   <li>`x-small`</li>   <li>`small`</li>   <li>`medium`</li>   <li>`large`</li>   <li>`x-large`</li>   <li>`xx-large`</li> </ul>
+    attr_accessor :size
+
+    # Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background.
+    attr_accessor :background
+
+    # Place the title in one of nine predefined positions of the viewport. <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
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -56,7 +67,11 @@ module Shotstack
         :'type' => :'type',
         :'text' => :'text',
         :'style' => :'style',
-        :'position' => :'position'
+        :'color' => :'color',
+        :'size' => :'size',
+        :'background' => :'background',
+        :'position' => :'position',
+        :'offset' => :'offset'
       }
     end
 
@@ -66,10 +81,20 @@ module Shotstack
         :'type' => :'String',
         :'text' => :'String',
         :'style' => :'String',
-        :'position' => :'String'
+        :'color' => :'String',
+        :'size' => :'String',
+        :'background' => :'String',
+        :'position' => :'String',
+        :'offset' => :'Offset'
       }
     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 = {})
@@ -99,11 +124,31 @@ module Shotstack
         self.style = attributes[:'style']
       end
 
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      else
+        self.color = '#ffffff'
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      else
+        self.size = 'medium'
+      end
+
+      if attributes.key?(:'background')
+        self.background = attributes[:'background']
+      end
+
       if attributes.key?(:'position')
         self.position = attributes[:'position']
       else
         self.position = 'center'
       end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,8 +171,10 @@ module Shotstack
     def valid?
       return false if @type.nil?
       return false if @text.nil?
-      style_validator = EnumAttributeValidator.new('String', ["minimal", "blockbuster", "vogue", "sketchy", "skinny"])
+      style_validator = EnumAttributeValidator.new('String', ["minimal", "blockbuster", "vogue", "sketchy", "skinny", "chunk", "chunkLight", "marker", "future", "subtitle"])
       return false unless style_validator.valid?(@style)
+      size_validator = EnumAttributeValidator.new('String', ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"])
+      return false unless size_validator.valid?(@size)
       position_validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"])
       return false unless position_validator.valid?(@position)
       true
@@ -136,13 +183,23 @@ module Shotstack
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] style Object to be assigned
     def style=(style)
-      validator = EnumAttributeValidator.new('String', ["minimal", "blockbuster", "vogue", "sketchy", "skinny"])
+      validator = EnumAttributeValidator.new('String', ["minimal", "blockbuster", "vogue", "sketchy", "skinny", "chunk", "chunkLight", "marker", "future", "subtitle"])
       unless validator.valid?(style)
         fail ArgumentError, "invalid value for \"style\", must be one of #{validator.allowable_values}."
       end
       @style = style
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] size Object to be assigned
+    def size=(size)
+      validator = EnumAttributeValidator.new('String', ["xx-small", "x-small", "small", "medium", "large", "x-large", "xx-large"])
+      unless validator.valid?(size)
+        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
+      end
+      @size = size
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] position Object to be assigned
     def position=(position)
@@ -161,7 +218,11 @@ module Shotstack
           type == o.type &&
           text == o.text &&
           style == o.style &&
-          position == o.position
+          color == o.color &&
+          size == o.size &&
+          background == o.background &&
+          position == o.position &&
+          offset == o.offset
     end
 
     # @see the `==` method
@@ -173,7 +234,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, text, style, position].hash
+      [type, text, style, color, size, background, position, offset].hash
     end
 
     # Builds the object from hash
@@ -262,7 +323,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