shotstack 0.1.1 → 0.1.6

data/lib/shotstack/models/edit.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
   # An edit defines the content of the video in a timeline and the output format.
@@ -19,24 +20,56 @@ module Shotstack
 
     attr_accessor :output
 
-    # An optional webhook callback URL used to receive status notifications when a render completes or fails.
+    # An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for  more details.
     attr_accessor :callback
 
+    # The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimised for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
+    attr_accessor :disk
+
+    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
       {
         :'timeline' => :'timeline',
         :'output' => :'output',
-        :'callback' => :'callback'
+        :'callback' => :'callback',
+        :'disk' => :'disk'
       }
     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
       {
         :'timeline' => :'Timeline',
         :'output' => :'Output',
-        :'callback' => :'String'
+        :'callback' => :'String',
+        :'disk' => :'String'
       }
     end
 
@@ -72,6 +105,12 @@ module Shotstack
       if attributes.key?(:'callback')
         self.callback = attributes[:'callback']
       end
+
+      if attributes.key?(:'disk')
+        self.disk = attributes[:'disk']
+      else
+        self.disk = 'local'
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,9 +133,21 @@ module Shotstack
     def valid?
       return false if @timeline.nil?
       return false if @output.nil?
+      disk_validator = EnumAttributeValidator.new('String', ["local", "mount"])
+      return false unless disk_validator.valid?(@disk)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] disk Object to be assigned
+    def disk=(disk)
+      validator = EnumAttributeValidator.new('String', ["local", "mount"])
+      unless validator.valid?(disk)
+        fail ArgumentError, "invalid value for \"disk\", must be one of #{validator.allowable_values}."
+      end
+      @disk = disk
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -104,7 +155,8 @@ module Shotstack
       self.class == o.class &&
           timeline == o.timeline &&
           output == o.output &&
-          callback == o.callback
+          callback == o.callback &&
+          disk == o.disk
     end
 
     # @see the `==` method
@@ -116,7 +168,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [timeline, output, callback].hash
+      [timeline, output, callback, disk].hash
     end
 
     # Builds the object from hash
@@ -132,7 +184,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)
@@ -140,7 +194,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
@@ -152,8 +206,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
@@ -183,7 +237,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
 
@@ -209,7 +265,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
@@ -232,5 +288,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/font.rb

@@ -1,19 +1,20 @@
 =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
-  # Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag.
+  # Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.
   class Font
     # The URL of the font file. The URL must be publicly accessible or include credentials.
     attr_accessor :src
@@ -25,6 +26,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
       {
@@ -109,7 +115,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)
@@ -117,7 +125,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
@@ -129,8 +137,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
@@ -160,7 +168,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
 
@@ -186,7 +196,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
@@ -209,5 +219,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/html_asset.rb

@@ -1,40 +1,41 @@
 =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 HtmlAsset clip type lets you create text based layout and formatting using HTML and CSS. You can also set the height and width of a bounding box for the HTML content to sit within. Text and elements will wrap within the bounding box.
   class HtmlAsset < Asset
-    # The type of asset - set to <b>html</b> for HTML.
+    # The type of asset - set to `html` for HTML.
     attr_accessor :type
 
-    # The HTML text string.
+    # The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
     attr_accessor :html
 
-    # The CSS text string to apply styling to the HTML.
+    # The CSS text string to apply styling to the HTML. See list of  [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
     attr_accessor :css
 
-    # Set the width of the HTML asset bounding box. Text will wrap to fill the bounding box.
+    # Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.
     attr_accessor :width
 
-    # Set the width of the HTML asset bounding box. Text and elements will be masked if they exceed the  height of the bounding box.
+    # Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the  height of the bounding box.
     attr_accessor :height
 
     # Apply a background color behind the HTML bounding box using. 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 :background
 
-    # Place the HTML in one of nine predefined positions within the HTML area.
+    # Place the HTML in one of nine predefined positions within the HTML area. <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
 
     class EnumAttributeValidator
@@ -72,14 +73,19 @@ 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
       {
         :'type' => :'String',
         :'html' => :'String',
         :'css' => :'String',
-        :'width' => :'Float',
-        :'height' => :'Float',
+        :'width' => :'Integer',
+        :'height' => :'Integer',
         :'background' => :'String',
         :'position' => :'String'
       }
@@ -215,7 +221,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)
@@ -223,7 +231,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
@@ -235,8 +243,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
@@ -266,7 +274,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
 
@@ -292,7 +302,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
@@ -315,5 +325,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end

data/lib/shotstack/models/image_asset.rb

@@ -1,40 +1,50 @@
 =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 ImageAsset is used to create video from images. The src must be a publicly accessible URL to an image resource such as a jpg or png file.
   class ImageAsset < Asset
-    # The type of asset - set to <b>image</b> for images.
+    # The type of asset - set to `image` for images.
     attr_accessor :type
 
-    # The image source URL. The URL must be publicly accessible or include credentials. 
+    # The image source URL. The URL must be publicly accessible or include credentials.
     attr_accessor :src
 
+    attr_accessor :crop
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'src' => :'src'
+        :'src' => :'src',
+        :'crop' => :'crop'
       }
     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'
+        :'src' => :'String',
+        :'crop' => :'Crop'
       }
     end
 
@@ -68,6 +78,10 @@ module Shotstack
       if attributes.key?(:'src')
         self.src = attributes[:'src']
       end
+
+      if attributes.key?(:'crop')
+        self.crop = attributes[:'crop']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -99,7 +113,8 @@ module Shotstack
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          src == o.src
+          src == o.src &&
+          crop == o.crop
     end
 
     # @see the `==` method
@@ -111,7 +126,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, src].hash
+      [type, src, crop].hash
     end
 
     # Builds the object from hash
@@ -127,7 +142,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)
@@ -135,7 +152,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
@@ -147,8 +164,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
@@ -178,7 +195,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
 
@@ -204,7 +223,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
@@ -227,5 +246,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end