mux_ruby 1.8.1 → 2.0.0

data/lib/mux_ruby/models/asset_errors.rb

@@ -1,14 +1,25 @@
 =begin
-# Mux Ruby - Copyright 2019 Mux Inc.
-# NOTE: This file is auto generated. Do not edit this file manually.
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
 =end
 
 require 'date'
+require 'time'
 
 module MuxRuby
+  # Object that describes any errors that happened when processing this asset.
   class AssetErrors
+    # The type of error that occurred for this asset.
     attr_accessor :type
 
+    # Error messages with more details.
     attr_accessor :messages
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,6 +30,11 @@ module MuxRuby
       }
     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
       {
@@ -27,19 +43,32 @@ module MuxRuby
       }
     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 `MuxRuby::AssetErrors` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `MuxRuby::AssetErrors`. 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.has_key?(:'type')
+      if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
 
-      if attributes.has_key?(:'messages')
+      if attributes.key?(:'messages')
         if (value = attributes[:'messages']).is_a?(Array)
           self.messages = value
         end
@@ -75,7 +104,7 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [type, messages].hash
     end
@@ -93,7 +122,9 @@ module MuxRuby
     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)
@@ -101,7 +132,7 @@ module MuxRuby
           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
@@ -113,8 +144,8 @@ module MuxRuby
     # @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
@@ -123,7 +154,7 @@ module MuxRuby
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -144,7 +175,9 @@ module MuxRuby
           end
         end
       else # model
-        MuxRuby.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = MuxRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -166,7 +199,11 @@ module MuxRuby
       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/mux_ruby/models/asset_master.rb

@@ -1,16 +1,48 @@
 =begin
-# Mux Ruby - Copyright 2019 Mux Inc.
-# NOTE: This file is auto generated. Do not edit this file manually.
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
 =end
 
 require 'date'
+require 'time'
 
 module MuxRuby
+  # An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_acess` is set to `none` and when the temporary URL expires.
   class AssetMaster
     attr_accessor :status
 
+    # The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
     attr_accessor :url
 
+    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
       {
@@ -19,6 +51,11 @@ module MuxRuby
       }
     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
       {
@@ -27,19 +64,32 @@ module MuxRuby
       }
     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 `MuxRuby::AssetMaster` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `MuxRuby::AssetMaster`. 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.has_key?(:'status')
+      if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
 
-      if attributes.has_key?(:'url')
+      if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
     end
@@ -54,9 +104,21 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      status_validator = EnumAttributeValidator.new('String', ["ready", "preparing", "errored"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["ready", "preparing", "errored"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -73,7 +135,7 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [status, url].hash
     end
@@ -91,7 +153,9 @@ module MuxRuby
     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)
@@ -99,7 +163,7 @@ module MuxRuby
           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
@@ -111,8 +175,8 @@ module MuxRuby
     # @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
@@ -121,7 +185,7 @@ module MuxRuby
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -142,7 +206,9 @@ module MuxRuby
           end
         end
       else # model
-        MuxRuby.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = MuxRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -164,7 +230,11 @@ module MuxRuby
       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/mux_ruby/models/asset_non_standard_input_reasons.rb

@@ -1,37 +1,46 @@
 =begin
-# Mux Ruby - Copyright 2019 Mux Inc.
-# NOTE: This file is auto generated. Do not edit this file manually.
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
 =end
 
 require 'date'
+require 'time'
 
 module MuxRuby
+  # An object containing one or more reasons the input file is non-standard. See [the guide on minimizing processing time](https://docs.mux.com/guides/video/minimize-processing-time) for more information on what a standard input is defined as. This object only exists on on-demand assets that have non-standard inputs, so if missing you can assume the input qualifies as standard.
   class AssetNonStandardInputReasons
-    # The video codec used on the input file
+    # The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`.
     attr_accessor :video_codec
 
-    # The audio codec used on the input file
+    # The audio codec used on the input file. Non-AAC audio codecs are non-standard.
     attr_accessor :audio_codec
 
-    # The video key frame Interval (also called as Group of Picture or GOP) of the input file
+    # The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 10 seconds.
     attr_accessor :video_gop_size
 
-    # The video frame rate of the input file
+    # The video frame rate of the input file. Video with average frames per second (fps) less than 10 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track.
     attr_accessor :video_frame_rate
 
-    # The video resolution of the input file
+    # The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels.
     attr_accessor :video_resolution
 
-    # The video pixel aspect ratio of the input file
+    # The video pixel aspect ratio of the input file.
     attr_accessor :pixel_aspect_ratio
 
-    # Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List
+    # Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List.
     attr_accessor :video_edit_list
 
-    # Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List
+    # Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List.
     attr_accessor :audio_edit_list
 
-    # A catch-all reason when the input file in created with non-standard encoding parameters
+    # A catch-all reason when the input file in created with non-standard encoding parameters.
     attr_accessor :unexpected_media_file_parameters
 
     class EnumAttributeValidator
@@ -71,6 +80,11 @@ module MuxRuby
       }
     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
       {
@@ -86,47 +100,60 @@ module MuxRuby
       }
     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 `MuxRuby::AssetNonStandardInputReasons` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `MuxRuby::AssetNonStandardInputReasons`. 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.has_key?(:'video_codec')
+      if attributes.key?(:'video_codec')
         self.video_codec = attributes[:'video_codec']
       end
 
-      if attributes.has_key?(:'audio_codec')
+      if attributes.key?(:'audio_codec')
         self.audio_codec = attributes[:'audio_codec']
       end
 
-      if attributes.has_key?(:'video_gop_size')
+      if attributes.key?(:'video_gop_size')
         self.video_gop_size = attributes[:'video_gop_size']
       end
 
-      if attributes.has_key?(:'video_frame_rate')
+      if attributes.key?(:'video_frame_rate')
         self.video_frame_rate = attributes[:'video_frame_rate']
       end
 
-      if attributes.has_key?(:'video_resolution')
+      if attributes.key?(:'video_resolution')
         self.video_resolution = attributes[:'video_resolution']
       end
 
-      if attributes.has_key?(:'pixel_aspect_ratio')
+      if attributes.key?(:'pixel_aspect_ratio')
         self.pixel_aspect_ratio = attributes[:'pixel_aspect_ratio']
       end
 
-      if attributes.has_key?(:'video_edit_list')
+      if attributes.key?(:'video_edit_list')
         self.video_edit_list = attributes[:'video_edit_list']
       end
 
-      if attributes.has_key?(:'audio_edit_list')
+      if attributes.key?(:'audio_edit_list')
         self.audio_edit_list = attributes[:'audio_edit_list']
       end
 
-      if attributes.has_key?(:'unexpected_media_file_parameters')
+      if attributes.key?(:'unexpected_media_file_parameters')
         self.unexpected_media_file_parameters = attributes[:'unexpected_media_file_parameters']
       end
     end
@@ -141,13 +168,13 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      video_gop_size_validator = EnumAttributeValidator.new('String', ['high'])
+      video_gop_size_validator = EnumAttributeValidator.new('String', ["high"])
       return false unless video_gop_size_validator.valid?(@video_gop_size)
-      video_edit_list_validator = EnumAttributeValidator.new('String', ['non-standard'])
+      video_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
       return false unless video_edit_list_validator.valid?(@video_edit_list)
-      audio_edit_list_validator = EnumAttributeValidator.new('String', ['non-standard'])
+      audio_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
       return false unless audio_edit_list_validator.valid?(@audio_edit_list)
-      unexpected_media_file_parameters_validator = EnumAttributeValidator.new('String', ['non-standard'])
+      unexpected_media_file_parameters_validator = EnumAttributeValidator.new('String', ["non-standard"])
       return false unless unexpected_media_file_parameters_validator.valid?(@unexpected_media_file_parameters)
       true
     end
@@ -155,9 +182,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] video_gop_size Object to be assigned
     def video_gop_size=(video_gop_size)
-      validator = EnumAttributeValidator.new('String', ['high'])
+      validator = EnumAttributeValidator.new('String', ["high"])
       unless validator.valid?(video_gop_size)
-        fail ArgumentError, 'invalid value for "video_gop_size", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"video_gop_size\", must be one of #{validator.allowable_values}."
       end
       @video_gop_size = video_gop_size
     end
@@ -165,9 +192,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] video_edit_list Object to be assigned
     def video_edit_list=(video_edit_list)
-      validator = EnumAttributeValidator.new('String', ['non-standard'])
+      validator = EnumAttributeValidator.new('String', ["non-standard"])
       unless validator.valid?(video_edit_list)
-        fail ArgumentError, 'invalid value for "video_edit_list", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"video_edit_list\", must be one of #{validator.allowable_values}."
       end
       @video_edit_list = video_edit_list
     end
@@ -175,9 +202,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] audio_edit_list Object to be assigned
     def audio_edit_list=(audio_edit_list)
-      validator = EnumAttributeValidator.new('String', ['non-standard'])
+      validator = EnumAttributeValidator.new('String', ["non-standard"])
       unless validator.valid?(audio_edit_list)
-        fail ArgumentError, 'invalid value for "audio_edit_list", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"audio_edit_list\", must be one of #{validator.allowable_values}."
       end
       @audio_edit_list = audio_edit_list
     end
@@ -185,9 +212,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] unexpected_media_file_parameters Object to be assigned
     def unexpected_media_file_parameters=(unexpected_media_file_parameters)
-      validator = EnumAttributeValidator.new('String', ['non-standard'])
+      validator = EnumAttributeValidator.new('String', ["non-standard"])
       unless validator.valid?(unexpected_media_file_parameters)
-        fail ArgumentError, 'invalid value for "unexpected_media_file_parameters", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"unexpected_media_file_parameters\", must be one of #{validator.allowable_values}."
       end
       @unexpected_media_file_parameters = unexpected_media_file_parameters
     end
@@ -215,7 +242,7 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [video_codec, audio_codec, video_gop_size, video_frame_rate, video_resolution, pixel_aspect_ratio, video_edit_list, audio_edit_list, unexpected_media_file_parameters].hash
     end
@@ -233,7 +260,9 @@ module MuxRuby
     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)
@@ -241,7 +270,7 @@ module MuxRuby
           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
@@ -253,8 +282,8 @@ module MuxRuby
     # @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
@@ -263,7 +292,7 @@ module MuxRuby
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -284,7 +313,9 @@ module MuxRuby
           end
         end
       else # model
-        MuxRuby.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = MuxRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -306,7 +337,11 @@ module MuxRuby
       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