mux_ruby 3.3.1 → 3.4.0

data/lib/mux_ruby/models/track.rb

@@ -21,7 +21,7 @@ module MuxRuby
     # The type of track
     attr_accessor :type
 
-    # The duration in seconds of the track media. This parameter is not set for the `text` type track. This field is optional and may not be set. The top level `duration` field of an asset will always be set.
+    # The duration in seconds of the track media. This parameter is not set for `text` type tracks. This field is optional and may not be set. The top level `duration` field of an asset will always be set.
     attr_accessor :duration
 
     # The maximum width in pixels available for the track. Only set for the `video` type track.
@@ -39,21 +39,24 @@ module MuxRuby
     # Only set for the `audio` type track.
     attr_accessor :max_channel_layout
 
-    # This parameter is set only for the `text` type track.
+    # This parameter is only set for `text` type tracks.
     attr_accessor :text_type
 
-    # The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is set for `text` type and `subtitles` text type track.
+    # The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is only set for `text` type and `subtitles` text type tracks.
     attr_accessor :language_code
 
-    # The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is set for the `text` type and `subtitles` text type track.
+    # The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is only set for `text` type and `subtitles` text type tracks.
     attr_accessor :name
 
-    # Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the `text` type and `subtitles` text type track.
+    # Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for `text` type and `subtitles` text type tracks.
     attr_accessor :closed_captions
 
-    # Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is set for `text` type and `subtitles` text type track. Max 255 characters.
+    # Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters.
     attr_accessor :passthrough
 
+    # The status of the track. This parameter is only set for `text` type tracks.
+    attr_accessor :status
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -91,7 +94,8 @@ module MuxRuby
         :'language_code' => :'language_code',
         :'name' => :'name',
         :'closed_captions' => :'closed_captions',
-        :'passthrough' => :'passthrough'
+        :'passthrough' => :'passthrough',
+        :'status' => :'status'
       }
     end
 
@@ -115,7 +119,8 @@ module MuxRuby
         :'language_code' => :'String',
         :'name' => :'String',
         :'closed_captions' => :'Boolean',
-        :'passthrough' => :'String'
+        :'passthrough' => :'String',
+        :'status' => :'String'
       }
     end
 
@@ -191,6 +196,10 @@ module MuxRuby
       if attributes.key?(:'passthrough')
         self.passthrough = attributes[:'passthrough']
       end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -207,6 +216,8 @@ module MuxRuby
       return false unless type_validator.valid?(@type)
       text_type_validator = EnumAttributeValidator.new('String', ["subtitles"])
       return false unless text_type_validator.valid?(@text_type)
+      status_validator = EnumAttributeValidator.new('String', ["preparing", "ready", "errored"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
@@ -230,6 +241,16 @@ module MuxRuby
       @text_type = text_type
     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
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -247,7 +268,8 @@ module MuxRuby
           language_code == o.language_code &&
           name == o.name &&
           closed_captions == o.closed_captions &&
-          passthrough == o.passthrough
+          passthrough == o.passthrough &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -259,7 +281,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, type, duration, max_width, max_height, max_frame_rate, max_channels, max_channel_layout, text_type, language_code, name, closed_captions, passthrough].hash
+      [id, type, duration, max_width, max_height, max_frame_rate, max_channels, max_channel_layout, text_type, language_code, name, closed_captions, passthrough, status].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/update_live_stream_request.rb

@@ -24,6 +24,9 @@ module MuxRuby
     # 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.
     attr_accessor :reconnect_window
 
+    # The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.
+    attr_accessor :max_continuous_duration
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +54,8 @@ module MuxRuby
       {
         :'passthrough' => :'passthrough',
         :'latency_mode' => :'latency_mode',
-        :'reconnect_window' => :'reconnect_window'
+        :'reconnect_window' => :'reconnect_window',
+        :'max_continuous_duration' => :'max_continuous_duration'
       }
     end
 
@@ -65,7 +69,8 @@ module MuxRuby
       {
         :'passthrough' => :'String',
         :'latency_mode' => :'String',
-        :'reconnect_window' => :'Float'
+        :'reconnect_window' => :'Float',
+        :'max_continuous_duration' => :'Integer'
       }
     end
 
@@ -101,6 +106,12 @@ module MuxRuby
       if attributes.key?(:'reconnect_window')
         self.reconnect_window = attributes[:'reconnect_window']
       end
+
+      if attributes.key?(:'max_continuous_duration')
+        self.max_continuous_duration = attributes[:'max_continuous_duration']
+      else
+        self.max_continuous_duration = 43200
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,6 +126,14 @@ module MuxRuby
         invalid_properties.push('invalid value for "reconnect_window", must be greater than or equal to 0.1.')
       end
 
+      if !@max_continuous_duration.nil? && @max_continuous_duration > 43200
+        invalid_properties.push('invalid value for "max_continuous_duration", must be smaller than or equal to 43200.')
+      end
+
+      if !@max_continuous_duration.nil? && @max_continuous_duration < 60
+        invalid_properties.push('invalid value for "max_continuous_duration", must be greater than or equal to 60.')
+      end
+
       invalid_properties
     end
 
@@ -125,6 +144,8 @@ module MuxRuby
       return false unless latency_mode_validator.valid?(@latency_mode)
       return false if !@reconnect_window.nil? && @reconnect_window > 300
       return false if !@reconnect_window.nil? && @reconnect_window < 0.1
+      return false if !@max_continuous_duration.nil? && @max_continuous_duration > 43200
+      return false if !@max_continuous_duration.nil? && @max_continuous_duration < 60
       true
     end
 
@@ -152,6 +173,20 @@ module MuxRuby
       @reconnect_window = reconnect_window
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] max_continuous_duration Value to be assigned
+    def max_continuous_duration=(max_continuous_duration)
+      if !max_continuous_duration.nil? && max_continuous_duration > 43200
+        fail ArgumentError, 'invalid value for "max_continuous_duration", must be smaller than or equal to 43200.'
+      end
+
+      if !max_continuous_duration.nil? && max_continuous_duration < 60
+        fail ArgumentError, 'invalid value for "max_continuous_duration", must be greater than or equal to 60.'
+      end
+
+      @max_continuous_duration = max_continuous_duration
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -159,7 +194,8 @@ module MuxRuby
       self.class == o.class &&
           passthrough == o.passthrough &&
           latency_mode == o.latency_mode &&
-          reconnect_window == o.reconnect_window
+          reconnect_window == o.reconnect_window &&
+          max_continuous_duration == o.max_continuous_duration
     end
 
     # @see the `==` method
@@ -171,7 +207,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [passthrough, latency_mode, reconnect_window].hash
+      [passthrough, latency_mode, reconnect_window, max_continuous_duration].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb

@@ -14,196 +14,91 @@ require 'date'
 require 'time'
 
 module MuxRuby
-  class UpdateReferrerDomainRestrictionRequest
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-      }
-    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
-      {
-      }
-    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 = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::UpdateReferrerDomainRestrictionRequest` initialize method"
+  module UpdateReferrerDomainRestrictionRequest
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ReferrerDomainRestriction'
+        ]
       end
 
-      # 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::UpdateReferrerDomainRestrictionRequest`. 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
-      }
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      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?
-      true
-    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
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [].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)
-        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) })
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are defacto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
         end
-      end
 
-      self
-    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)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # 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)
+        openapi_one_of.include?(:AnyType) ? data : nil
       end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
 
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = MuxRuby.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
         end
 
-        hash[param] = _to_hash(value)
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
       end
-      hash
     end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end

data/lib/mux_ruby/models/video_view.rb

@@ -515,6 +515,109 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'view_total_upscaling',
+        :'preroll_ad_asset_hostname',
+        :'player_source_domain',
+        :'region',
+        :'viewer_user_agent',
+        :'preroll_requested',
+        :'page_type',
+        :'startup_score',
+        :'view_seek_duration',
+        :'country_name',
+        :'player_source_height',
+        :'longitude',
+        :'buffering_count',
+        :'video_duration',
+        :'player_source_type',
+        :'city',
+        :'platform_description',
+        :'video_startup_preroll_request_time',
+        :'viewer_device_name',
+        :'video_series',
+        :'viewer_application_name',
+        :'view_total_content_playback_time',
+        :'cdn',
+        :'player_instance_id',
+        :'video_language',
+        :'player_source_width',
+        :'player_error_message',
+        :'player_mux_plugin_version',
+        :'playback_score',
+        :'page_url',
+        :'metro',
+        :'view_max_request_latency',
+        :'requests_for_first_preroll',
+        :'view_total_downscaling',
+        :'latitude',
+        :'player_source_host_name',
+        :'mux_embed_version',
+        :'player_language',
+        :'page_load_time',
+        :'viewer_device_category',
+        :'video_startup_preroll_load_time',
+        :'player_version',
+        :'watch_time',
+        :'player_source_stream_type',
+        :'preroll_ad_tag_hostname',
+        :'viewer_device_manufacturer',
+        :'rebuffering_score',
+        :'experiment_name',
+        :'viewer_os_version',
+        :'buffering_duration',
+        :'player_view_count',
+        :'player_software',
+        :'player_load_time',
+        :'platform_summary',
+        :'video_encoding_variant',
+        :'player_width',
+        :'view_seek_count',
+        :'viewer_experience_score',
+        :'view_error_id',
+        :'video_variant_name',
+        :'preroll_played',
+        :'viewer_application_engine',
+        :'viewer_os_architecture',
+        :'player_error_code',
+        :'buffering_rate',
+        :'player_name',
+        :'view_average_request_throughput',
+        :'video_producer',
+        :'error_type_id',
+        :'video_id',
+        :'continent_code',
+        :'video_content_type',
+        :'viewer_os_family',
+        :'player_poster',
+        :'view_average_request_latency',
+        :'video_variant_id',
+        :'player_source_duration',
+        :'player_source_url',
+        :'video_title',
+        :'rebuffer_percentage',
+        :'time_to_first_frame',
+        :'viewer_user_id',
+        :'video_stream_type',
+        :'player_startup_time',
+        :'viewer_application_version',
+        :'view_max_downscale_percentage',
+        :'view_max_upscale_percentage',
+        :'country_code',
+        :'isp',
+        :'player_height',
+        :'asn',
+        :'asn_name',
+        :'quality_score',
+        :'player_software_version',
+        :'player_mux_plugin_name',
+        :'sub_property_id',
+        :'player_remote_played',
+        :'view_max_playhead_position',
+        :'view_playing_time',
+        :'view_session_id',
+        :'viewer_connection_type',
+        :'viewer_device_model',
+        :'weighted_average_bitrate'
       ])
     end
 

data/lib/mux_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.1
 =end
 
 module MuxRuby
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end