shotstack 0.2.1 → 0.2.6

data/lib/shotstack/models/mux_destination.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -14,9 +14,9 @@ require 'date'
 require 'time'
 
 module Shotstack
-  # Send rendered videos to the [Mux](https://www.mux.com/) video hosting and streaming service. Add the `mux` destination provider to send the output video to Mux. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
+  # Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
   class MuxDestination
-    # The destination to send rendered assets to - set to `mux` for Mux.
+    # The destination to send video to - set to `mux` for Mux.
     attr_accessor :provider
 
     attr_accessor :options
@@ -77,6 +77,7 @@ module Shotstack
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @provider.nil?
         invalid_properties.push('invalid value for "provider", provider cannot be nil.')
@@ -88,6 +89,7 @@ module Shotstack
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @provider.nil?
       true
     end
@@ -117,36 +119,30 @@ module Shotstack
     # @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)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -181,7 +177,7 @@ module Shotstack
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/shotstack/models/mux_destination_options.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -14,11 +14,14 @@ require 'date'
 require 'time'
 
 module Shotstack
-  # Pass additional options to control how Mux processes video. Currently supports playback policy option.
+  # Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
   class MuxDestinationOptions
     # Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.
     attr_accessor :playback_policy
 
+    # Sets the Mux `passthrough` option. Max 255 characters.
+    attr_accessor :passthrough
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -44,7 +47,8 @@ module Shotstack
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'playback_policy' => :'playbackPolicy'
+        :'playback_policy' => :'playbackPolicy',
+        :'passthrough' => :'passthrough'
       }
     end
 
@@ -56,7 +60,8 @@ module Shotstack
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'playback_policy' => :'Array<String>'
+        :'playback_policy' => :'Array<String>',
+        :'passthrough' => :'String'
       }
     end
 
@@ -86,27 +91,53 @@ module Shotstack
           self.playback_policy = value
         end
       end
+
+      if attributes.key?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@passthrough.nil? && @passthrough.to_s.length > 255
+        invalid_properties.push('invalid value for "passthrough", the character length must be smaller than or equal to 255.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@passthrough.nil? && @passthrough.to_s.length > 255
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] passthrough Value to be assigned
+    def passthrough=(passthrough)
+      if passthrough.nil?
+        fail ArgumentError, 'passthrough cannot be nil'
+      end
+
+      if passthrough.to_s.length > 255
+        fail ArgumentError, 'invalid value for "passthrough", the character length must be smaller than or equal to 255.'
+      end
+
+      @passthrough = passthrough
+    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 &&
-          playback_policy == o.playback_policy
+          playback_policy == o.playback_policy &&
+          passthrough == o.passthrough
     end
 
     # @see the `==` method
@@ -118,43 +149,37 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [playback_policy].hash
+      [playback_policy, passthrough].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -189,7 +214,7 @@ module Shotstack
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/shotstack/models/offset.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -16,10 +16,10 @@ require 'time'
 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.
+    # Offset an asset on the horizontal axis (left or right), range varies from -10 to 10. 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.
+    # Offset an asset on the vertical axis (up or down), range varies from -10 to 10. 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.
@@ -66,35 +66,32 @@ module Shotstack
 
       if attributes.key?(:'x')
         self.x = attributes[:'x']
-      else
-        self.x = 0
       end
 
       if attributes.key?(:'y')
         self.y = attributes[:'y']
-      else
-        self.y = 0
       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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@x.nil? && @x > 1
-        invalid_properties.push('invalid value for "x", must be smaller than or equal to 1.')
+      if !@x.nil? && @x > 10
+        invalid_properties.push('invalid value for "x", must be smaller than or equal to 10.')
       end
 
-      if !@x.nil? && @x < -1
-        invalid_properties.push('invalid value for "x", must be greater than or equal to -1.')
+      if !@x.nil? && @x < -10
+        invalid_properties.push('invalid value for "x", must be greater than or equal to -10.')
       end
 
-      if !@y.nil? && @y > 1
-        invalid_properties.push('invalid value for "y", must be smaller than or equal to 1.')
+      if !@y.nil? && @y > 10
+        invalid_properties.push('invalid value for "y", must be smaller than or equal to 10.')
       end
 
-      if !@y.nil? && @y < -1
-        invalid_properties.push('invalid value for "y", must be greater than or equal to -1.')
+      if !@y.nil? && @y < -10
+        invalid_properties.push('invalid value for "y", must be greater than or equal to -10.')
       end
 
       invalid_properties
@@ -103,22 +100,27 @@ module Shotstack
     # 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
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@x.nil? && @x > 10
+      return false if !@x.nil? && @x < -10
+      return false if !@y.nil? && @y > 10
+      return false if !@y.nil? && @y < -10
       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.'
+      if x.nil?
+        fail ArgumentError, 'x cannot be nil'
+      end
+
+      if x > 10
+        fail ArgumentError, 'invalid value for "x", must be smaller than or equal to 10.'
       end
 
-      if !x.nil? && x < -1
-        fail ArgumentError, 'invalid value for "x", must be greater than or equal to -1.'
+      if x < -10
+        fail ArgumentError, 'invalid value for "x", must be greater than or equal to -10.'
       end
 
       @x = x
@@ -127,12 +129,16 @@ module Shotstack
     # 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.'
+      if y.nil?
+        fail ArgumentError, 'y cannot be nil'
+      end
+
+      if y > 10
+        fail ArgumentError, 'invalid value for "y", must be smaller than or equal to 10.'
       end
 
-      if !y.nil? && y < -1
-        fail ArgumentError, 'invalid value for "y", must be greater than or equal to -1.'
+      if y < -10
+        fail ArgumentError, 'invalid value for "y", must be greater than or equal to -10.'
       end
 
       @y = y
@@ -163,36 +169,30 @@ module Shotstack
     # @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)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -227,7 +227,7 @@ module Shotstack
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end