mux_ruby 1.8.1 → 2.0.0

data/lib/mux_ruby/models/abridged_video_view.rb

@@ -1,9 +1,17 @@
 =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
   class AbridgedVideoView
@@ -46,6 +54,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
       {
@@ -63,55 +76,68 @@ 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::AbridgedVideoView` 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::AbridgedVideoView`. 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?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'viewer_os_family')
+      if attributes.key?(:'viewer_os_family')
         self.viewer_os_family = attributes[:'viewer_os_family']
       end
 
-      if attributes.has_key?(:'viewer_application_name')
+      if attributes.key?(:'viewer_application_name')
         self.viewer_application_name = attributes[:'viewer_application_name']
       end
 
-      if attributes.has_key?(:'video_title')
+      if attributes.key?(:'video_title')
         self.video_title = attributes[:'video_title']
       end
 
-      if attributes.has_key?(:'total_row_count')
+      if attributes.key?(:'total_row_count')
         self.total_row_count = attributes[:'total_row_count']
       end
 
-      if attributes.has_key?(:'player_error_message')
+      if attributes.key?(:'player_error_message')
         self.player_error_message = attributes[:'player_error_message']
       end
 
-      if attributes.has_key?(:'player_error_code')
+      if attributes.key?(:'player_error_code')
         self.player_error_code = attributes[:'player_error_code']
       end
 
-      if attributes.has_key?(:'error_type_id')
+      if attributes.key?(:'error_type_id')
         self.error_type_id = attributes[:'error_type_id']
       end
 
-      if attributes.has_key?(:'country_code')
+      if attributes.key?(:'country_code')
         self.country_code = attributes[:'country_code']
       end
 
-      if attributes.has_key?(:'view_start')
+      if attributes.key?(:'view_start')
         self.view_start = attributes[:'view_start']
       end
 
-      if attributes.has_key?(:'view_end')
+      if attributes.key?(:'view_end')
         self.view_end = attributes[:'view_end']
       end
     end
@@ -154,7 +180,7 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, viewer_os_family, viewer_application_name, video_title, total_row_count, player_error_message, player_error_code, error_type_id, country_code, view_start, view_end].hash
     end
@@ -172,7 +198,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)
@@ -180,7 +208,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
@@ -192,8 +220,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
@@ -202,7 +230,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
@@ -223,7 +251,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
 
@@ -245,7 +275,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.rb

@@ -1,40 +1,61 @@
 =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
   class Asset
+    # Unique identifier for the Asset. Max 255 characters.
     attr_accessor :id
 
+    # Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
     attr_accessor :created_at
 
-    attr_accessor :deleted_at
-
+    # The status of the asset.
     attr_accessor :status
 
+    # The duration of the asset in seconds (max duration for a single asset is 12 hours).
     attr_accessor :duration
 
+    # The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored.
     attr_accessor :max_stored_resolution
 
+    # The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
     attr_accessor :max_stored_frame_rate
 
+    # The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     attr_accessor :aspect_ratio
 
+    # An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details.
     attr_accessor :playback_ids
 
+    # The individual media tracks that make up an asset.
     attr_accessor :tracks
 
     attr_accessor :errors
 
     attr_accessor :per_title_encode
 
+    # Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
+    attr_accessor :upload_id
+
+    # Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state.
     attr_accessor :is_live
 
+    # Arbitrary metadata set for the asset. Max 255 characters.
     attr_accessor :passthrough
 
+    # Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
     attr_accessor :live_stream_id
 
     attr_accessor :master
@@ -43,6 +64,10 @@ module MuxRuby
 
     attr_accessor :mp4_support
 
+    # Asset Identifier of the video used as the source for creating the clip.
+    attr_accessor :source_asset_id
+
+    # Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
     attr_accessor :normalize_audio
 
     attr_accessor :static_renditions
@@ -52,6 +77,7 @@ module MuxRuby
 
     attr_accessor :non_standard_input_reasons
 
+    # True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs.
     attr_accessor :test
 
     class EnumAttributeValidator
@@ -81,7 +107,6 @@ module MuxRuby
       {
         :'id' => :'id',
         :'created_at' => :'created_at',
-        :'deleted_at' => :'deleted_at',
         :'status' => :'status',
         :'duration' => :'duration',
         :'max_stored_resolution' => :'max_stored_resolution',
@@ -91,12 +116,14 @@ module MuxRuby
         :'tracks' => :'tracks',
         :'errors' => :'errors',
         :'per_title_encode' => :'per_title_encode',
+        :'upload_id' => :'upload_id',
         :'is_live' => :'is_live',
         :'passthrough' => :'passthrough',
         :'live_stream_id' => :'live_stream_id',
         :'master' => :'master',
         :'master_access' => :'master_access',
         :'mp4_support' => :'mp4_support',
+        :'source_asset_id' => :'source_asset_id',
         :'normalize_audio' => :'normalize_audio',
         :'static_renditions' => :'static_renditions',
         :'recording_times' => :'recording_times',
@@ -105,12 +132,16 @@ 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
       {
         :'id' => :'String',
         :'created_at' => :'String',
-        :'deleted_at' => :'String',
         :'status' => :'String',
         :'duration' => :'Float',
         :'max_stored_resolution' => :'String',
@@ -119,130 +150,149 @@ module MuxRuby
         :'playback_ids' => :'Array<PlaybackID>',
         :'tracks' => :'Array<Track>',
         :'errors' => :'AssetErrors',
-        :'per_title_encode' => :'BOOLEAN',
-        :'is_live' => :'BOOLEAN',
+        :'per_title_encode' => :'Boolean',
+        :'upload_id' => :'String',
+        :'is_live' => :'Boolean',
         :'passthrough' => :'String',
         :'live_stream_id' => :'String',
         :'master' => :'AssetMaster',
         :'master_access' => :'String',
         :'mp4_support' => :'String',
-        :'normalize_audio' => :'BOOLEAN',
+        :'source_asset_id' => :'String',
+        :'normalize_audio' => :'Boolean',
         :'static_renditions' => :'AssetStaticRenditions',
         :'recording_times' => :'Array<AssetRecordingTimes>',
         :'non_standard_input_reasons' => :'AssetNonStandardInputReasons',
-        :'test' => :'BOOLEAN'
+        :'test' => :'Boolean'
       }
     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::Asset` 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::Asset`. 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?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'created_at')
+      if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.has_key?(:'deleted_at')
-        self.deleted_at = attributes[:'deleted_at']
-      end
-
-      if attributes.has_key?(:'status')
+      if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
 
-      if attributes.has_key?(:'duration')
+      if attributes.key?(:'duration')
         self.duration = attributes[:'duration']
       end
 
-      if attributes.has_key?(:'max_stored_resolution')
+      if attributes.key?(:'max_stored_resolution')
         self.max_stored_resolution = attributes[:'max_stored_resolution']
       end
 
-      if attributes.has_key?(:'max_stored_frame_rate')
+      if attributes.key?(:'max_stored_frame_rate')
         self.max_stored_frame_rate = attributes[:'max_stored_frame_rate']
       end
 
-      if attributes.has_key?(:'aspect_ratio')
+      if attributes.key?(:'aspect_ratio')
         self.aspect_ratio = attributes[:'aspect_ratio']
       end
 
-      if attributes.has_key?(:'playback_ids')
+      if attributes.key?(:'playback_ids')
         if (value = attributes[:'playback_ids']).is_a?(Array)
           self.playback_ids = value
         end
       end
 
-      if attributes.has_key?(:'tracks')
+      if attributes.key?(:'tracks')
         if (value = attributes[:'tracks']).is_a?(Array)
           self.tracks = value
         end
       end
 
-      if attributes.has_key?(:'errors')
+      if attributes.key?(:'errors')
         self.errors = attributes[:'errors']
       end
 
-      if attributes.has_key?(:'per_title_encode')
+      if attributes.key?(:'per_title_encode')
         self.per_title_encode = attributes[:'per_title_encode']
       end
 
-      if attributes.has_key?(:'is_live')
+      if attributes.key?(:'upload_id')
+        self.upload_id = attributes[:'upload_id']
+      end
+
+      if attributes.key?(:'is_live')
         self.is_live = attributes[:'is_live']
       end
 
-      if attributes.has_key?(:'passthrough')
+      if attributes.key?(:'passthrough')
         self.passthrough = attributes[:'passthrough']
       end
 
-      if attributes.has_key?(:'live_stream_id')
+      if attributes.key?(:'live_stream_id')
         self.live_stream_id = attributes[:'live_stream_id']
       end
 
-      if attributes.has_key?(:'master')
+      if attributes.key?(:'master')
         self.master = attributes[:'master']
       end
 
-      if attributes.has_key?(:'master_access')
+      if attributes.key?(:'master_access')
         self.master_access = attributes[:'master_access']
       else
         self.master_access = 'none'
       end
 
-      if attributes.has_key?(:'mp4_support')
+      if attributes.key?(:'mp4_support')
         self.mp4_support = attributes[:'mp4_support']
       else
         self.mp4_support = 'none'
       end
 
-      if attributes.has_key?(:'normalize_audio')
+      if attributes.key?(:'source_asset_id')
+        self.source_asset_id = attributes[:'source_asset_id']
+      end
+
+      if attributes.key?(:'normalize_audio')
         self.normalize_audio = attributes[:'normalize_audio']
       else
         self.normalize_audio = false
       end
 
-      if attributes.has_key?(:'static_renditions')
+      if attributes.key?(:'static_renditions')
         self.static_renditions = attributes[:'static_renditions']
       end
 
-      if attributes.has_key?(:'recording_times')
+      if attributes.key?(:'recording_times')
         if (value = attributes[:'recording_times']).is_a?(Array)
           self.recording_times = value
         end
       end
 
-      if attributes.has_key?(:'non_standard_input_reasons')
+      if attributes.key?(:'non_standard_input_reasons')
         self.non_standard_input_reasons = attributes[:'non_standard_input_reasons']
       end
 
-      if attributes.has_key?(:'test')
+      if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
     end
@@ -257,21 +307,33 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      max_stored_resolution_validator = EnumAttributeValidator.new('String', ['Audio only', 'SD', 'HD', 'FHD', 'UHD'])
+      status_validator = EnumAttributeValidator.new('String', ["preparing", "ready", "errored"])
+      return false unless status_validator.valid?(@status)
+      max_stored_resolution_validator = EnumAttributeValidator.new('String', ["Audio only", "SD", "HD", "FHD", "UHD"])
       return false unless max_stored_resolution_validator.valid?(@max_stored_resolution)
-      master_access_validator = EnumAttributeValidator.new('String', ['temporary', 'none'])
+      master_access_validator = EnumAttributeValidator.new('String', ["temporary", "none"])
       return false unless master_access_validator.valid?(@master_access)
-      mp4_support_validator = EnumAttributeValidator.new('String', ['standard', 'none'])
+      mp4_support_validator = EnumAttributeValidator.new('String', ["standard", "none"])
       return false unless mp4_support_validator.valid?(@mp4_support)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["preparing", "ready", "errored"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] max_stored_resolution Object to be assigned
     def max_stored_resolution=(max_stored_resolution)
-      validator = EnumAttributeValidator.new('String', ['Audio only', 'SD', 'HD', 'FHD', 'UHD'])
+      validator = EnumAttributeValidator.new('String', ["Audio only", "SD", "HD", "FHD", "UHD"])
       unless validator.valid?(max_stored_resolution)
-        fail ArgumentError, 'invalid value for "max_stored_resolution", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"max_stored_resolution\", must be one of #{validator.allowable_values}."
       end
       @max_stored_resolution = max_stored_resolution
     end
@@ -279,9 +341,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] master_access Object to be assigned
     def master_access=(master_access)
-      validator = EnumAttributeValidator.new('String', ['temporary', 'none'])
+      validator = EnumAttributeValidator.new('String', ["temporary", "none"])
       unless validator.valid?(master_access)
-        fail ArgumentError, 'invalid value for "master_access", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"master_access\", must be one of #{validator.allowable_values}."
       end
       @master_access = master_access
     end
@@ -289,9 +351,9 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] mp4_support Object to be assigned
     def mp4_support=(mp4_support)
-      validator = EnumAttributeValidator.new('String', ['standard', 'none'])
+      validator = EnumAttributeValidator.new('String', ["standard", "none"])
       unless validator.valid?(mp4_support)
-        fail ArgumentError, 'invalid value for "mp4_support", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"mp4_support\", must be one of #{validator.allowable_values}."
       end
       @mp4_support = mp4_support
     end
@@ -303,7 +365,6 @@ module MuxRuby
       self.class == o.class &&
           id == o.id &&
           created_at == o.created_at &&
-          deleted_at == o.deleted_at &&
           status == o.status &&
           duration == o.duration &&
           max_stored_resolution == o.max_stored_resolution &&
@@ -313,12 +374,14 @@ module MuxRuby
           tracks == o.tracks &&
           errors == o.errors &&
           per_title_encode == o.per_title_encode &&
+          upload_id == o.upload_id &&
           is_live == o.is_live &&
           passthrough == o.passthrough &&
           live_stream_id == o.live_stream_id &&
           master == o.master &&
           master_access == o.master_access &&
           mp4_support == o.mp4_support &&
+          source_asset_id == o.source_asset_id &&
           normalize_audio == o.normalize_audio &&
           static_renditions == o.static_renditions &&
           recording_times == o.recording_times &&
@@ -333,9 +396,9 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, created_at, deleted_at, status, duration, max_stored_resolution, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, is_live, passthrough, live_stream_id, master, master_access, mp4_support, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
+      [id, created_at, status, duration, max_stored_resolution, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
     end
 
     # Builds the object from hash
@@ -351,7 +414,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)
@@ -359,7 +424,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
@@ -371,8 +436,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
@@ -381,7 +446,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
@@ -402,7 +467,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
 
@@ -424,7 +491,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