shotstack 0.0.10 → 0.1.3

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
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+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
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -14,17 +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
 
+    # 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
@@ -52,7 +66,12 @@ module Shotstack
       {
         :'type' => :'type',
         :'text' => :'text',
-        :'style' => :'style'
+        :'style' => :'style',
+        :'color' => :'color',
+        :'size' => :'size',
+        :'background' => :'background',
+        :'position' => :'position',
+        :'offset' => :'offset'
       }
     end
 
@@ -61,10 +80,21 @@ module Shotstack
       {
         :'type' => :'String',
         :'text' => :'String',
-        :'style' => :'String'
+        :'style' => :'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 = {})
@@ -93,6 +123,32 @@ module Shotstack
       if attributes.key?(:'style')
         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?
@@ -115,21 +171,45 @@ 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
     end
 
     # 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)
+      validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"])
+      unless validator.valid?(position)
+        fail ArgumentError, "invalid value for \"position\", must be one of #{validator.allowable_values}."
+      end
+      @position = position
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -137,7 +217,12 @@ module Shotstack
       self.class == o.class &&
           type == o.type &&
           text == o.text &&
-          style == o.style
+          style == o.style &&
+          color == o.color &&
+          size == o.size &&
+          background == o.background &&
+          position == o.position &&
+          offset == o.offset
     end
 
     # @see the `==` method
@@ -149,7 +234,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, text, style].hash
+      [type, text, style, color, size, background, position, offset].hash
     end
 
     # Builds the object from hash
@@ -238,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

data/lib/shotstack/models/track.rb

@@ -1,19 +1,19 @@
 =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
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
 require 'date'
 
 module Shotstack
-  # A track contains an array of clips. Tracks are layered on top of each other in the order in the array. The top most track will render on top of those below it. 
+  # A track contains an array of clips. Tracks are layered on top of each other in the order in the array. The top most track will render on top of those below it.
   class Track
     # An array of Clips comprising of TitleClip, ImageClip or VideoClip.
     attr_accessor :clips
@@ -32,6 +32,12 @@ module Shotstack
       }
     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 = {})
@@ -178,7 +184,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/transition.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
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -15,10 +15,10 @@ require 'date'
 module Shotstack
   # In and out transitions for a clip - i.e. fade in and fade out
   class Transition
-    # The transition in
+    # The transition in. Available transitions are:   <ul>     <li>`fade` - fade in</li>     <li>`reveal` - reveal from left to right</li>     <li>`wipeLeft` - fade across screen to the left</li>     <li>`wipeRight` - fade across screen to the right</li>     <li>`slideLeft` - move slightly left and fade in</li>     <li>`slideRight` - move slightly right and fade in</li>     <li>`slideUp` - move slightly up and fade in</li>     <li>`slideDown` - move slightly down and fade in</li>     <li>`carouselLeft` - slide in from right to left</li>     <li>`carouselRight` - slide in from left to right</li>     <li>`carouselUp` - slide in from bottom to top</li>     <li>`carouselDown` - slide in from top  to bottom</li>     <li>`zoom` - fast zoom in</li>   </ul>
     attr_accessor :_in
 
-    # The transition out
+    # The transition out. Available transitions are:   <ul>     <li>`fade` - fade out</li>     <li>`reveal` - reveal from right to left</li>     <li>`wipeLeft` - fade across screen to the left</li>     <li>`wipeRight` - fade across screen to the right</li>     <li>`slideLeft` - move slightly left and fade out</li>     <li>`slideRight` - move slightly right and fade out</li>     <li>`slideUp` - move slightly up and fade out</li>     <li>`slideDown` - move slightly down and fade out</li>     <li>`carouselLeft` - slide out from right to left</li>     <li>`carouselRight` - slide out from left to right</li>     <li>`carouselUp` - slide out from bottom to top</li>     <li>`carouselDown` - slide out from top  to bottom</li>     <li>`zoom` - fast zoom out</li>   </ul>
     attr_accessor :out
 
     class EnumAttributeValidator
@@ -59,6 +59,12 @@ module Shotstack
       }
     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 = {})
@@ -93,9 +99,9 @@ module Shotstack
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      _in_validator = EnumAttributeValidator.new('String', ["fade", "wipeLeft", "wipeRight"])
+      _in_validator = EnumAttributeValidator.new('String', ["fade", "reveal", "wipeLeft", "wipeRight", "slideLeft", "slideRight", "slideUp", "slideDown", "carouselLeft", "carouselRight", "carouselUp", "carouselDown", "zoom"])
       return false unless _in_validator.valid?(@_in)
-      out_validator = EnumAttributeValidator.new('String', ["fade", "wipeLeft", "wipeRight"])
+      out_validator = EnumAttributeValidator.new('String', ["fade", "reveal", "wipeLeft", "wipeRight", "slideLeft", "slideRight", "slideUp", "slideDown", "carouselLeft", "carouselRight", "carouselUp", "carouselDown", "zoom"])
       return false unless out_validator.valid?(@out)
       true
     end
@@ -103,7 +109,7 @@ module Shotstack
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] _in Object to be assigned
     def _in=(_in)
-      validator = EnumAttributeValidator.new('String', ["fade", "wipeLeft", "wipeRight"])
+      validator = EnumAttributeValidator.new('String', ["fade", "reveal", "wipeLeft", "wipeRight", "slideLeft", "slideRight", "slideUp", "slideDown", "carouselLeft", "carouselRight", "carouselUp", "carouselDown", "zoom"])
       unless validator.valid?(_in)
         fail ArgumentError, "invalid value for \"_in\", must be one of #{validator.allowable_values}."
       end
@@ -113,7 +119,7 @@ module Shotstack
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] out Object to be assigned
     def out=(out)
-      validator = EnumAttributeValidator.new('String', ["fade", "wipeLeft", "wipeRight"])
+      validator = EnumAttributeValidator.new('String', ["fade", "reveal", "wipeLeft", "wipeRight", "slideLeft", "slideRight", "slideUp", "slideDown", "carouselLeft", "carouselRight", "carouselUp", "carouselDown", "zoom"])
       unless validator.valid?(out)
         fail ArgumentError, "invalid value for \"out\", must be one of #{validator.allowable_values}."
       end
@@ -227,7 +233,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/video_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
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -14,18 +14,18 @@ require 'date'
 require_relative 'asset'
 
 module Shotstack
-  # The VideoAsset is used to create video sequences from video files. The src must be a publicly accesible URL to a video resource such as an mp4 file. The in and out attributes of the parent Clip let you trim the video file by setting the start and end point to use. 
+  # The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.
   class VideoAsset < Asset
-    # The type of asset - set to <b>video</b> for videos.
+    # The type of asset - set to `video` for videos.
     attr_accessor :type
 
-    # The video source URL. The URL must be publicly accessible or include credentials. 
+    # The video source URL. The URL must be publicly accessible or include credentials.
     attr_accessor :src
 
-    # The start trim point of the clip, in seconds (defaults to 0). Videos will start from the in trim point. The video will play until the file ends or the Clip length is reached. 
+    # The start trim point of the video clip, in seconds (defaults to 0). Videos will start from the in trim point. The video will play until the file ends or the Clip length is reached.
     attr_accessor :trim
 
-    # Set the volume for the clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0). 
+    # Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0).
     attr_accessor :volume
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -48,6 +48,12 @@ module Shotstack
       }
     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 = {})
@@ -214,7 +220,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