mux_ruby 2.1.0 → 3.1.0

data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb

@@ -0,0 +1,287 @@
+=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 LiveStreamEmbeddedSubtitleSettings
+    # A name for this live stream closed caption track.
+    attr_accessor :name
+
+    # Arbitrary metadata set for the live stream closed caption track. Max 255 characters.
+    attr_accessor :passthrough
+
+    # The language of the closed caption stream. Value must be BCP 47 compliant.
+    attr_accessor :language_code
+
+    # CEA-608 caption channel to read data from.
+    attr_accessor :language_channel
+
+    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
+      {
+        :'name' => :'name',
+        :'passthrough' => :'passthrough',
+        :'language_code' => :'language_code',
+        :'language_channel' => :'language_channel'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'passthrough' => :'String',
+        :'language_code' => :'String',
+        :'language_channel' => :'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::LiveStreamEmbeddedSubtitleSettings` 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::LiveStreamEmbeddedSubtitleSettings`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
+      end
+
+      if attributes.key?(:'language_code')
+        self.language_code = attributes[:'language_code']
+      else
+        self.language_code = 'en'
+      end
+
+      if attributes.key?(:'language_channel')
+        self.language_channel = attributes[:'language_channel']
+      else
+        self.language_channel = 'cc1'
+      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?
+      language_channel_validator = EnumAttributeValidator.new('String', ["cc1"])
+      return false unless language_channel_validator.valid?(@language_channel)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] language_channel Object to be assigned
+    def language_channel=(language_channel)
+      validator = EnumAttributeValidator.new('String', ["cc1"])
+      unless validator.valid?(language_channel)
+        fail ArgumentError, "invalid value for \"language_channel\", must be one of #{validator.allowable_values}."
+      end
+      @language_channel = language_channel
+    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 &&
+          name == o.name &&
+          passthrough == o.passthrough &&
+          language_code == o.language_code &&
+          language_channel == o.language_channel
+    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
+      [name, passthrough, language_code, language_channel].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/real_time_breakdown_value.rb

@@ -23,7 +23,7 @@ module MuxRuby
 
     attr_accessor :display_value
 
-    attr_accessor :concurent_viewers
+    attr_accessor :concurrent_viewers
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -32,7 +32,7 @@ module MuxRuby
         :'negative_impact' => :'negative_impact',
         :'metric_value' => :'metric_value',
         :'display_value' => :'display_value',
-        :'concurent_viewers' => :'concurent_viewers'
+        :'concurrent_viewers' => :'concurrent_viewers'
       }
     end
 
@@ -48,7 +48,7 @@ module MuxRuby
         :'negative_impact' => :'Integer',
         :'metric_value' => :'Float',
         :'display_value' => :'String',
-        :'concurent_viewers' => :'Integer'
+        :'concurrent_viewers' => :'Integer'
       }
     end
 
@@ -89,8 +89,8 @@ module MuxRuby
         self.display_value = attributes[:'display_value']
       end
 
-      if attributes.key?(:'concurent_viewers')
-        self.concurent_viewers = attributes[:'concurent_viewers']
+      if attributes.key?(:'concurrent_viewers')
+        self.concurrent_viewers = attributes[:'concurrent_viewers']
       end
     end
 
@@ -116,7 +116,7 @@ module MuxRuby
           negative_impact == o.negative_impact &&
           metric_value == o.metric_value &&
           display_value == o.display_value &&
-          concurent_viewers == o.concurent_viewers
+          concurrent_viewers == o.concurrent_viewers
     end
 
     # @see the `==` method
@@ -128,7 +128,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, negative_impact, metric_value, display_value, concurent_viewers].hash
+      [value, negative_impact, metric_value, display_value, concurrent_viewers].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb

@@ -19,14 +19,14 @@ module MuxRuby
 
     attr_accessor :date
 
-    attr_accessor :concurent_viewers
+    attr_accessor :concurrent_viewers
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'value' => :'value',
         :'date' => :'date',
-        :'concurent_viewers' => :'concurent_viewers'
+        :'concurrent_viewers' => :'concurrent_viewers'
       }
     end
 
@@ -40,7 +40,7 @@ module MuxRuby
       {
         :'value' => :'Float',
         :'date' => :'String',
-        :'concurent_viewers' => :'Integer'
+        :'concurrent_viewers' => :'Integer'
       }
     end
 
@@ -73,8 +73,8 @@ module MuxRuby
         self.date = attributes[:'date']
       end
 
-      if attributes.key?(:'concurent_viewers')
-        self.concurent_viewers = attributes[:'concurent_viewers']
+      if attributes.key?(:'concurrent_viewers')
+        self.concurrent_viewers = attributes[:'concurrent_viewers']
       end
     end
 
@@ -98,7 +98,7 @@ module MuxRuby
       self.class == o.class &&
           value == o.value &&
           date == o.date &&
-          concurent_viewers == o.concurent_viewers
+          concurrent_viewers == o.concurrent_viewers
     end
 
     # @see the `==` method
@@ -110,7 +110,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, date, concurent_viewers].hash
+      [value, date, concurrent_viewers].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/track.rb

@@ -205,8 +205,6 @@ module MuxRuby
     def valid?
       type_validator = EnumAttributeValidator.new('String', ["video", "audio", "text"])
       return false unless type_validator.valid?(@type)
-      max_channel_layout_validator = EnumAttributeValidator.new('String', ["mono", "stereo", "5.2", "7.1"])
-      return false unless max_channel_layout_validator.valid?(@max_channel_layout)
       text_type_validator = EnumAttributeValidator.new('String', ["subtitles"])
       return false unless text_type_validator.valid?(@text_type)
       true
@@ -222,16 +220,6 @@ module MuxRuby
       @type = type
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] max_channel_layout Object to be assigned
-    def max_channel_layout=(max_channel_layout)
-      validator = EnumAttributeValidator.new('String', ["mono", "stereo", "5.2", "7.1"])
-      unless validator.valid?(max_channel_layout)
-        fail ArgumentError, "invalid value for \"max_channel_layout\", must be one of #{validator.allowable_values}."
-      end
-      @max_channel_layout = max_channel_layout
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] text_type Object to be assigned
     def text_type=(text_type)

data/lib/mux_ruby/models/update_live_stream_embedded_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 UpdateLiveStreamEmbeddedSubtitlesRequest
+    # Describe the embedded closed caption contents of the incoming live stream.
+    attr_accessor :embedded_subtitles
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'embedded_subtitles' => :'embedded_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
+      {
+        :'embedded_subtitles' => :'Array<LiveStreamEmbeddedSubtitleSettings>'
+      }
+    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::UpdateLiveStreamEmbeddedSubtitlesRequest` 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::UpdateLiveStreamEmbeddedSubtitlesRequest`. 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?(:'embedded_subtitles')
+        if (value = attributes[:'embedded_subtitles']).is_a?(Array)
+          self.embedded_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 &&
+          embedded_subtitles == o.embedded_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
+      [embedded_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/version.rb

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

data/lib/mux_ruby.rb

@@ -48,6 +48,7 @@ require 'mux_ruby/models/get_asset_or_live_stream_id_response'
 require 'mux_ruby/models/get_asset_or_live_stream_id_response_data'
 require 'mux_ruby/models/get_asset_or_live_stream_id_response_data_object'
 require 'mux_ruby/models/get_asset_playback_id_response'
+require 'mux_ruby/models/get_live_stream_playback_id_response'
 require 'mux_ruby/models/get_metric_timeseries_data_response'
 require 'mux_ruby/models/get_overall_values_response'
 require 'mux_ruby/models/get_real_time_breakdown_response'
@@ -88,6 +89,7 @@ require 'mux_ruby/models/list_uploads_response'
 require 'mux_ruby/models/list_video_view_exports_response'
 require 'mux_ruby/models/list_video_views_response'
 require 'mux_ruby/models/live_stream'
+require 'mux_ruby/models/live_stream_embedded_subtitle_settings'
 require 'mux_ruby/models/live_stream_response'
 require 'mux_ruby/models/metric'
 require 'mux_ruby/models/notification_rule'
@@ -108,6 +110,7 @@ require 'mux_ruby/models/simulcast_target_response'
 require 'mux_ruby/models/track'
 require 'mux_ruby/models/update_asset_mp4_support_request'
 require 'mux_ruby/models/update_asset_master_access_request'
+require 'mux_ruby/models/update_live_stream_embedded_subtitles_request'
 require 'mux_ruby/models/upload'
 require 'mux_ruby/models/upload_error'
 require 'mux_ruby/models/upload_response'

data/mux_ruby.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://docs.mux.com"
   s.summary     = "Mux API Ruby Gem"
   s.description = "The Ruby client for Mux Data and Mux Video."
+  s.metadata    = { "source_code_uri" => "https://github.com/muxinc/mux-ruby" }
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.4"