mux_ruby 3.12.0 → 3.14.0

data/lib/mux_ruby/models/abridged_video_view.rb

@@ -37,6 +37,10 @@ module MuxRuby
 
     attr_accessor :view_end
 
+    attr_accessor :viewer_experience_score
+
+    attr_accessor :watch_time
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -50,7 +54,9 @@ module MuxRuby
         :'error_type_id' => :'error_type_id',
         :'country_code' => :'country_code',
         :'view_start' => :'view_start',
-        :'view_end' => :'view_end'
+        :'view_end' => :'view_end',
+        :'viewer_experience_score' => :'viewer_experience_score',
+        :'watch_time' => :'watch_time'
       }
     end
 
@@ -72,7 +78,9 @@ module MuxRuby
         :'error_type_id' => :'Integer',
         :'country_code' => :'String',
         :'view_start' => :'String',
-        :'view_end' => :'String'
+        :'view_end' => :'String',
+        :'viewer_experience_score' => :'Float',
+        :'watch_time' => :'Integer'
       }
     end
 
@@ -86,6 +94,8 @@ module MuxRuby
         :'player_error_code',
         :'error_type_id',
         :'country_code',
+        :'viewer_experience_score',
+        :'watch_time'
       ])
     end
 
@@ -147,6 +157,14 @@ module MuxRuby
       if attributes.key?(:'view_end')
         self.view_end = attributes[:'view_end']
       end
+
+      if attributes.key?(:'viewer_experience_score')
+        self.viewer_experience_score = attributes[:'viewer_experience_score']
+      end
+
+      if attributes.key?(:'watch_time')
+        self.watch_time = attributes[:'watch_time']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -177,7 +195,9 @@ module MuxRuby
           error_type_id == o.error_type_id &&
           country_code == o.country_code &&
           view_start == o.view_start &&
-          view_end == o.view_end
+          view_end == o.view_end &&
+          viewer_experience_score == o.viewer_experience_score &&
+          watch_time == o.watch_time
     end
 
     # @see the `==` method
@@ -189,7 +209,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].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
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/asset.rb

@@ -89,6 +89,9 @@ module MuxRuby
     # 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
 
+    # The type of ingest used to create the asset.
+    attr_accessor :ingest_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -140,7 +143,8 @@ module MuxRuby
         :'static_renditions' => :'static_renditions',
         :'recording_times' => :'recording_times',
         :'non_standard_input_reasons' => :'non_standard_input_reasons',
-        :'test' => :'test'
+        :'test' => :'test',
+        :'ingest_type' => :'ingest_type'
       }
     end
 
@@ -178,7 +182,8 @@ module MuxRuby
         :'static_renditions' => :'AssetStaticRenditions',
         :'recording_times' => :'Array<AssetRecordingTimes>',
         :'non_standard_input_reasons' => :'AssetNonStandardInputReasons',
-        :'test' => :'Boolean'
+        :'test' => :'Boolean',
+        :'ingest_type' => :'String'
       }
     end
 
@@ -322,6 +327,10 @@ module MuxRuby
       if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
+
+      if attributes.key?(:'ingest_type')
+        self.ingest_type = attributes[:'ingest_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -348,6 +357,8 @@ module MuxRuby
       return false unless master_access_validator.valid?(@master_access)
       mp4_support_validator = EnumAttributeValidator.new('String', ["standard", "none"])
       return false unless mp4_support_validator.valid?(@mp4_support)
+      ingest_type_validator = EnumAttributeValidator.new('String', ["on_demand_url", "on_demand_direct_upload", "on_demand_clip", "live_rtmp", "live_srt"])
+      return false unless ingest_type_validator.valid?(@ingest_type)
       true
     end
 
@@ -421,6 +432,16 @@ module MuxRuby
       @mp4_support = mp4_support
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ingest_type Object to be assigned
+    def ingest_type=(ingest_type)
+      validator = EnumAttributeValidator.new('String', ["on_demand_url", "on_demand_direct_upload", "on_demand_clip", "live_rtmp", "live_srt"])
+      unless validator.valid?(ingest_type)
+        fail ArgumentError, "invalid value for \"ingest_type\", must be one of #{validator.allowable_values}."
+      end
+      @ingest_type = ingest_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -452,7 +473,8 @@ module MuxRuby
           static_renditions == o.static_renditions &&
           recording_times == o.recording_times &&
           non_standard_input_reasons == o.non_standard_input_reasons &&
-          test == o.test
+          test == o.test &&
+          ingest_type == o.ingest_type
     end
 
     # @see the `==` method
@@ -464,7 +486,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, 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
+      [id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, 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, ingest_type].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb

@@ -115,7 +115,7 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      language_code_validator = EnumAttributeValidator.new('String', ["en", "en-US"])
+      language_code_validator = EnumAttributeValidator.new('String', ["en", "es", "it", "pt", "de", "fr", "pl", "ru", "nl", "ca", "tr", "sv", "uk", "no", "fi", "sk", "el", "cs", "hr", "da", "ro", "bg"])
       return false unless language_code_validator.valid?(@language_code)
       true
     end
@@ -123,7 +123,7 @@ module MuxRuby
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] language_code Object to be assigned
     def language_code=(language_code)
-      validator = EnumAttributeValidator.new('String', ["en", "en-US"])
+      validator = EnumAttributeValidator.new('String', ["en", "es", "it", "pt", "de", "fr", "pl", "ru", "nl", "ca", "tr", "sv", "uk", "no", "fi", "sk", "el", "cs", "hr", "da", "ro", "bg"])
       unless validator.valid?(language_code)
         fail ArgumentError, "invalid value for \"language_code\", must be one of #{validator.allowable_values}."
       end

data/lib/mux_ruby/models/create_simulcast_target_request.rb

@@ -18,10 +18,10 @@ module MuxRuby
     # Arbitrary user-supplied metadata set by you when creating a simulcast target.
     attr_accessor :passthrough
 
-    # Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to.
+    # Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations.
     attr_accessor :stream_key
 
-    # RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`.
+    # The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`.  Note: SRT simulcast targets can only be used when an source is connected over SRT. 
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mux_ruby/models/error.rb

@@ -39,6 +39,9 @@ module MuxRuby
     # The error code
     attr_accessor :code
 
+    # The string version of the error code
+    attr_accessor :player_error_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,7 +52,8 @@ module MuxRuby
         :'last_seen' => :'last_seen',
         :'description' => :'description',
         :'count' => :'count',
-        :'code' => :'code'
+        :'code' => :'code',
+        :'player_error_code' => :'player_error_code'
       }
     end
 
@@ -68,7 +72,8 @@ module MuxRuby
         :'last_seen' => :'String',
         :'description' => :'String',
         :'count' => :'Integer',
-        :'code' => :'Integer'
+        :'code' => :'Integer',
+        :'player_error_code' => :'String'
       }
     end
 
@@ -78,7 +83,8 @@ module MuxRuby
         :'notes',
         :'message',
         :'description',
-        :'code'
+        :'code',
+        :'player_error_code'
       ])
     end
 
@@ -128,6 +134,10 @@ module MuxRuby
       if attributes.key?(:'code')
         self.code = attributes[:'code']
       end
+
+      if attributes.key?(:'player_error_code')
+        self.player_error_code = attributes[:'player_error_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -155,7 +165,8 @@ module MuxRuby
           last_seen == o.last_seen &&
           description == o.description &&
           count == o.count &&
-          code == o.code
+          code == o.code &&
+          player_error_code == o.player_error_code
     end
 
     # @see the `==` method
@@ -167,7 +178,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, percentage, notes, message, last_seen, description, count, code].hash
+      [id, percentage, notes, message, last_seen, description, count, code, player_error_code].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/generate_track_subtitles_request.rb

@@ -0,0 +1,221 @@
+=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 GenerateTrackSubtitlesRequest
+    # Generate subtitle tracks using automatic speech recognition with this configuration.
+    attr_accessor :generated_subtitles
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'generated_subtitles' => :'generated_subtitles'
+      }
+    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
+      {
+        :'generated_subtitles' => :'Array<AssetGeneratedSubtitleSettings>'
+      }
+    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::GenerateTrackSubtitlesRequest` 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::GenerateTrackSubtitlesRequest`. 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?(:'generated_subtitles')
+        if (value = attributes[:'generated_subtitles']).is_a?(Array)
+          self.generated_subtitles = value
+        end
+      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 &&
+          generated_subtitles == o.generated_subtitles
+    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
+      [generated_subtitles].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

data/lib/mux_ruby/models/generate_track_subtitles_response.rb

@@ -0,0 +1,218 @@
+=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 GenerateTrackSubtitlesResponse
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'Track'
+      }
+    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::GenerateTrackSubtitlesResponse` 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::GenerateTrackSubtitlesResponse`. 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?(:'data')
+        self.data = attributes[:'data']
+      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 &&
+          data == o.data
+    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
+      [data].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