mux_ruby 1.9.0 → 2.1.0

data/lib/mux_ruby/models/live_stream.rb

@@ -1,38 +1,86 @@
 =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 LiveStream
+    # Unique identifier for the Live Stream. Max 255 characters.
     attr_accessor :id
 
+    # Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).
     attr_accessor :created_at
 
+    # Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.
     attr_accessor :stream_key
 
+    # The Asset that is currently being created if there is an active broadcast.
     attr_accessor :active_asset_id
 
+    # An array of strings with the most recent Assets that were created from this live stream.
     attr_accessor :recent_asset_ids
 
+    # `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published.
     attr_accessor :status
 
+    # 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
 
     attr_accessor :new_asset_settings
 
+    # Arbitrary metadata set for the asset. Max 255 characters.
     attr_accessor :passthrough
 
+    # The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.
+    attr_accessor :audio_only
+
+    # When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes).
     attr_accessor :reconnect_window
 
+    # Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs.
     attr_accessor :reduced_latency
 
+    # Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds.
+    attr_accessor :low_latency
+
+    # Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms).
     attr_accessor :simulcast_targets
 
+    # True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.
     attr_accessor :test
 
+    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
       {
@@ -45,13 +93,20 @@ module MuxRuby
         :'playback_ids' => :'playback_ids',
         :'new_asset_settings' => :'new_asset_settings',
         :'passthrough' => :'passthrough',
+        :'audio_only' => :'audio_only',
         :'reconnect_window' => :'reconnect_window',
         :'reduced_latency' => :'reduced_latency',
+        :'low_latency' => :'low_latency',
         :'simulcast_targets' => :'simulcast_targets',
         :'test' => :'test'
       }
     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
       {
@@ -64,76 +119,101 @@ module MuxRuby
         :'playback_ids' => :'Array<PlaybackID>',
         :'new_asset_settings' => :'CreateAssetRequest',
         :'passthrough' => :'String',
+        :'audio_only' => :'Boolean',
         :'reconnect_window' => :'Float',
-        :'reduced_latency' => :'BOOLEAN',
+        :'reduced_latency' => :'Boolean',
+        :'low_latency' => :'Boolean',
         :'simulcast_targets' => :'Array<SimulcastTarget>',
-        :'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::LiveStream` 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::LiveStream`. 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?(:'stream_key')
+      if attributes.key?(:'stream_key')
         self.stream_key = attributes[:'stream_key']
       end
 
-      if attributes.has_key?(:'active_asset_id')
+      if attributes.key?(:'active_asset_id')
         self.active_asset_id = attributes[:'active_asset_id']
       end
 
-      if attributes.has_key?(:'recent_asset_ids')
+      if attributes.key?(:'recent_asset_ids')
         if (value = attributes[:'recent_asset_ids']).is_a?(Array)
           self.recent_asset_ids = value
         end
       end
 
-      if attributes.has_key?(:'status')
+      if attributes.key?(:'status')
         self.status = attributes[:'status']
       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?(:'new_asset_settings')
+      if attributes.key?(:'new_asset_settings')
         self.new_asset_settings = attributes[:'new_asset_settings']
       end
 
-      if attributes.has_key?(:'passthrough')
+      if attributes.key?(:'passthrough')
         self.passthrough = attributes[:'passthrough']
       end
 
-      if attributes.has_key?(:'reconnect_window')
+      if attributes.key?(:'audio_only')
+        self.audio_only = attributes[:'audio_only']
+      end
+
+      if attributes.key?(:'reconnect_window')
         self.reconnect_window = attributes[:'reconnect_window']
+      else
+        self.reconnect_window = 60
       end
 
-      if attributes.has_key?(:'reduced_latency')
+      if attributes.key?(:'reduced_latency')
         self.reduced_latency = attributes[:'reduced_latency']
       end
 
-      if attributes.has_key?(:'simulcast_targets')
+      if attributes.key?(:'low_latency')
+        self.low_latency = attributes[:'low_latency']
+      end
+
+      if attributes.key?(:'simulcast_targets')
         if (value = attributes[:'simulcast_targets']).is_a?(Array)
           self.simulcast_targets = value
         end
       end
 
-      if attributes.has_key?(:'test')
+      if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
     end
@@ -148,9 +228,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', ["active", "idle", "disabled"])
+      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', ["active", "idle", "disabled"])
+      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)
@@ -165,8 +257,10 @@ module MuxRuby
           playback_ids == o.playback_ids &&
           new_asset_settings == o.new_asset_settings &&
           passthrough == o.passthrough &&
+          audio_only == o.audio_only &&
           reconnect_window == o.reconnect_window &&
           reduced_latency == o.reduced_latency &&
+          low_latency == o.low_latency &&
           simulcast_targets == o.simulcast_targets &&
           test == o.test
     end
@@ -178,9 +272,9 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, created_at, stream_key, active_asset_id, recent_asset_ids, status, playback_ids, new_asset_settings, passthrough, reconnect_window, reduced_latency, simulcast_targets, test].hash
+      [id, created_at, stream_key, active_asset_id, recent_asset_ids, status, playback_ids, new_asset_settings, passthrough, audio_only, reconnect_window, reduced_latency, low_latency, simulcast_targets, test].hash
     end
 
     # Builds the object from hash
@@ -196,7 +290,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)
@@ -204,7 +300,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
@@ -216,8 +312,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
@@ -226,7 +322,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
@@ -247,7 +343,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
 
@@ -269,7 +367,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/live_stream_response.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 LiveStreamResponse
@@ -16,6 +24,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
       {
@@ -23,15 +36,28 @@ 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::LiveStreamResponse` 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::LiveStreamResponse`. 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?(:'data')
+      if attributes.key?(:'data')
         self.data = attributes[:'data']
       end
     end
@@ -64,7 +90,7 @@ module MuxRuby
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [data].hash
     end
@@ -82,7 +108,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)
@@ -90,7 +118,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
@@ -102,8 +130,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
@@ -112,7 +140,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
@@ -133,7 +161,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
 
@@ -155,7 +185,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