mux_ruby 3.15.0 → 3.17.0

data/lib/mux_ruby/models/abridged_video_view.rb

@@ -41,6 +41,8 @@ module MuxRuby
 
     attr_accessor :watch_time
 
+    attr_accessor :playback_failure
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -56,7 +58,8 @@ module MuxRuby
         :'view_start' => :'view_start',
         :'view_end' => :'view_end',
         :'viewer_experience_score' => :'viewer_experience_score',
-        :'watch_time' => :'watch_time'
+        :'watch_time' => :'watch_time',
+        :'playback_failure' => :'playback_failure'
       }
     end
 
@@ -80,7 +83,8 @@ module MuxRuby
         :'view_start' => :'String',
         :'view_end' => :'String',
         :'viewer_experience_score' => :'Float',
-        :'watch_time' => :'Integer'
+        :'watch_time' => :'Integer',
+        :'playback_failure' => :'Boolean'
       }
     end
 
@@ -95,7 +99,7 @@ module MuxRuby
         :'error_type_id',
         :'country_code',
         :'viewer_experience_score',
-        :'watch_time'
+        :'watch_time',
       ])
     end
 
@@ -165,6 +169,10 @@ module MuxRuby
       if attributes.key?(:'watch_time')
         self.watch_time = attributes[:'watch_time']
       end
+
+      if attributes.key?(:'playback_failure')
+        self.playback_failure = attributes[:'playback_failure']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -197,7 +205,8 @@ module MuxRuby
           view_start == o.view_start &&
           view_end == o.view_end &&
           viewer_experience_score == o.viewer_experience_score &&
-          watch_time == o.watch_time
+          watch_time == o.watch_time &&
+          playback_failure == o.playback_failure
     end
 
     # @see the `==` method
@@ -209,7 +218,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @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, viewer_experience_score, watch_time].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, viewer_experience_score, watch_time, playback_failure].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_asset_request.rb

@@ -18,9 +18,12 @@ module MuxRuby
     # An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements.
     attr_accessor :input
 
-    # An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy.
+    # An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include:  * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset).  If no `playback_policy` is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. 
     attr_accessor :playback_policy
 
+    # An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. 
+    attr_accessor :advanced_playback_policies
+
     attr_accessor :per_title_encode
 
     # Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**.
@@ -71,6 +74,7 @@ module MuxRuby
       {
         :'input' => :'input',
         :'playback_policy' => :'playback_policy',
+        :'advanced_playback_policies' => :'advanced_playback_policies',
         :'per_title_encode' => :'per_title_encode',
         :'passthrough' => :'passthrough',
         :'mp4_support' => :'mp4_support',
@@ -92,6 +96,7 @@ module MuxRuby
       {
         :'input' => :'Array<InputSettings>',
         :'playback_policy' => :'Array<PlaybackPolicy>',
+        :'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
         :'per_title_encode' => :'Boolean',
         :'passthrough' => :'String',
         :'mp4_support' => :'String',
@@ -136,6 +141,12 @@ module MuxRuby
         end
       end
 
+      if attributes.key?(:'advanced_playback_policies')
+        if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
+          self.advanced_playback_policies = value
+        end
+      end
+
       if attributes.key?(:'per_title_encode')
         self.per_title_encode = attributes[:'per_title_encode']
       end
@@ -239,6 +250,7 @@ module MuxRuby
       self.class == o.class &&
           input == o.input &&
           playback_policy == o.playback_policy &&
+          advanced_playback_policies == o.advanced_playback_policies &&
           per_title_encode == o.per_title_encode &&
           passthrough == o.passthrough &&
           mp4_support == o.mp4_support &&
@@ -258,7 +270,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [input, playback_policy, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier].hash
+      [input, playback_policy, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_live_stream_request.rb

@@ -17,6 +17,9 @@ module MuxRuby
   class CreateLiveStreamRequest
     attr_accessor :playback_policy
 
+    # An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. 
+    attr_accessor :advanced_playback_policies
+
     attr_accessor :new_asset_settings
 
     # 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. Defaults to 60 seconds on the API if not specified.  If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams.  Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. 
@@ -82,6 +85,7 @@ module MuxRuby
     def self.attribute_map
       {
         :'playback_policy' => :'playback_policy',
+        :'advanced_playback_policies' => :'advanced_playback_policies',
         :'new_asset_settings' => :'new_asset_settings',
         :'reconnect_window' => :'reconnect_window',
         :'use_slate_for_standard_latency' => :'use_slate_for_standard_latency',
@@ -108,6 +112,7 @@ module MuxRuby
     def self.openapi_types
       {
         :'playback_policy' => :'Array<PlaybackPolicy>',
+        :'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
         :'new_asset_settings' => :'CreateAssetRequest',
         :'reconnect_window' => :'Float',
         :'use_slate_for_standard_latency' => :'Boolean',
@@ -152,6 +157,12 @@ module MuxRuby
         end
       end
 
+      if attributes.key?(:'advanced_playback_policies')
+        if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
+          self.advanced_playback_policies = value
+        end
+      end
+
       if attributes.key?(:'new_asset_settings')
         self.new_asset_settings = attributes[:'new_asset_settings']
       end
@@ -300,6 +311,7 @@ module MuxRuby
       return true if self.equal?(o)
       self.class == o.class &&
           playback_policy == o.playback_policy &&
+          advanced_playback_policies == o.advanced_playback_policies &&
           new_asset_settings == o.new_asset_settings &&
           reconnect_window == o.reconnect_window &&
           use_slate_for_standard_latency == o.use_slate_for_standard_latency &&
@@ -325,7 +337,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [playback_policy, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration].hash
+      [playback_policy, advanced_playback_policies, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_playback_id_request.rb

@@ -17,10 +17,14 @@ module MuxRuby
   class CreatePlaybackIDRequest
     attr_accessor :policy
 
+    # The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
+    attr_accessor :drm_configuration_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'policy' => :'policy'
+        :'policy' => :'policy',
+        :'drm_configuration_id' => :'drm_configuration_id'
       }
     end
 
@@ -32,7 +36,8 @@ module MuxRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'policy' => :'PlaybackPolicy'
+        :'policy' => :'PlaybackPolicy',
+        :'drm_configuration_id' => :'String'
       }
     end
 
@@ -60,6 +65,10 @@ module MuxRuby
       if attributes.key?(:'policy')
         self.policy = attributes[:'policy']
       end
+
+      if attributes.key?(:'drm_configuration_id')
+        self.drm_configuration_id = attributes[:'drm_configuration_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +89,8 @@ module MuxRuby
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          policy == o.policy
+          policy == o.policy &&
+          drm_configuration_id == o.drm_configuration_id
     end
 
     # @see the `==` method
@@ -92,7 +102,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [policy].hash
+      [policy, drm_configuration_id].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_playback_restriction_request.rb

@@ -17,10 +17,13 @@ module MuxRuby
   class CreatePlaybackRestrictionRequest
     attr_accessor :referrer
 
+    attr_accessor :user_agent
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'referrer' => :'referrer'
+        :'referrer' => :'referrer',
+        :'user_agent' => :'user_agent'
       }
     end
 
@@ -32,7 +35,8 @@ module MuxRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'referrer' => :'ReferrerDomainRestriction'
+        :'referrer' => :'ReferrerDomainRestriction',
+        :'user_agent' => :'UserAgentRestrictionRequest'
       }
     end
 
@@ -60,6 +64,10 @@ module MuxRuby
       if attributes.key?(:'referrer')
         self.referrer = attributes[:'referrer']
       end
+
+      if attributes.key?(:'user_agent')
+        self.user_agent = attributes[:'user_agent']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +88,8 @@ module MuxRuby
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          referrer == o.referrer
+          referrer == o.referrer &&
+          user_agent == o.user_agent
     end
 
     # @see the `==` method
@@ -92,7 +101,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [referrer].hash
+      [referrer, user_agent].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_upload_request.rb

@@ -23,6 +23,7 @@ module MuxRuby
 
     attr_accessor :new_asset_settings
 
+    # Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset.
     attr_accessor :test
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mux_ruby/models/delivery_report.rb

@@ -39,6 +39,9 @@ module MuxRuby
     # The resolution tier that the asset was ingested at, affecting billing for ingest & storage
     attr_accessor :asset_resolution_tier
 
+    # The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers)
+    attr_accessor :asset_encoding_tier
+
     # Total number of delivered seconds during this time window.
     attr_accessor :delivered_seconds
 
@@ -77,6 +80,7 @@ module MuxRuby
         :'asset_state' => :'asset_state',
         :'asset_duration' => :'asset_duration',
         :'asset_resolution_tier' => :'asset_resolution_tier',
+        :'asset_encoding_tier' => :'asset_encoding_tier',
         :'delivered_seconds' => :'delivered_seconds',
         :'delivered_seconds_by_resolution' => :'delivered_seconds_by_resolution'
       }
@@ -98,6 +102,7 @@ module MuxRuby
         :'asset_state' => :'String',
         :'asset_duration' => :'Float',
         :'asset_resolution_tier' => :'String',
+        :'asset_encoding_tier' => :'String',
         :'delivered_seconds' => :'Float',
         :'delivered_seconds_by_resolution' => :'DeliveryReportDeliveredSecondsByResolution'
       }
@@ -156,6 +161,10 @@ module MuxRuby
         self.asset_resolution_tier = attributes[:'asset_resolution_tier']
       end
 
+      if attributes.key?(:'asset_encoding_tier')
+        self.asset_encoding_tier = attributes[:'asset_encoding_tier']
+      end
+
       if attributes.key?(:'delivered_seconds')
         self.delivered_seconds = attributes[:'delivered_seconds']
       end
@@ -179,6 +188,8 @@ module MuxRuby
       return false unless asset_state_validator.valid?(@asset_state)
       asset_resolution_tier_validator = EnumAttributeValidator.new('String', ["audio-only", "720p", "1080p", "1440p", "2160p"])
       return false unless asset_resolution_tier_validator.valid?(@asset_resolution_tier)
+      asset_encoding_tier_validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
+      return false unless asset_encoding_tier_validator.valid?(@asset_encoding_tier)
       true
     end
 
@@ -202,6 +213,16 @@ module MuxRuby
       @asset_resolution_tier = asset_resolution_tier
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] asset_encoding_tier Object to be assigned
+    def asset_encoding_tier=(asset_encoding_tier)
+      validator = EnumAttributeValidator.new('String', ["smart", "baseline"])
+      unless validator.valid?(asset_encoding_tier)
+        fail ArgumentError, "invalid value for \"asset_encoding_tier\", must be one of #{validator.allowable_values}."
+      end
+      @asset_encoding_tier = asset_encoding_tier
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -215,6 +236,7 @@ module MuxRuby
           asset_state == o.asset_state &&
           asset_duration == o.asset_duration &&
           asset_resolution_tier == o.asset_resolution_tier &&
+          asset_encoding_tier == o.asset_encoding_tier &&
           delivered_seconds == o.delivered_seconds &&
           delivered_seconds_by_resolution == o.delivered_seconds_by_resolution
     end
@@ -228,7 +250,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [live_stream_id, asset_id, passthrough, created_at, deleted_at, asset_state, asset_duration, asset_resolution_tier, delivered_seconds, delivered_seconds_by_resolution].hash
+      [live_stream_id, asset_id, passthrough, created_at, deleted_at, asset_state, asset_duration, asset_resolution_tier, asset_encoding_tier, delivered_seconds, delivered_seconds_by_resolution].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/drm_configuration.rb

@@ -0,0 +1,219 @@
+=begin
+#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 DRMConfiguration
+    # Unique identifier for the DRM Configuration. Max 255 characters.
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id'
+      }
+    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'
+      }
+    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::DRMConfiguration` initialize method"
+      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::DRMConfiguration`. 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.key?(:'id')
+        self.id = attributes[:'id']
+      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
+      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 &&
+          id == o.id
+    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
+      [id].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) })
+          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)
+      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}"))
+        end
+
+        hash[param] = _to_hash(value)
+      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