mux_ruby 3.11.1 → 3.12.0

data/lib/mux_ruby/models/create_live_stream_request.rb

@@ -45,7 +45,7 @@ module MuxRuby
     # This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency.
     attr_accessor :low_latency
 
-    # Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/
+    # Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.
     attr_accessor :latency_mode
 
     # Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.

data/lib/mux_ruby/models/create_simulcast_target_request.rb

@@ -85,17 +85,12 @@ module MuxRuby
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @url.nil?
-        invalid_properties.push('invalid value for "url", url cannot be nil.')
-      end
-
       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?
-      return false if @url.nil?
       true
     end
 

data/lib/mux_ruby/models/create_upload_request.rb

@@ -102,10 +102,6 @@ module MuxRuby
         invalid_properties.push('invalid value for "timeout", must be greater than or equal to 60.')
       end
 
-      if @new_asset_settings.nil?
-        invalid_properties.push('invalid value for "new_asset_settings", new_asset_settings cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -114,7 +110,6 @@ module MuxRuby
     def valid?
       return false if !@timeout.nil? && @timeout > 604800
       return false if !@timeout.nil? && @timeout < 60
-      return false if @new_asset_settings.nil?
       true
     end
 

data/lib/mux_ruby/models/create_web_input_request.rb

@@ -0,0 +1,355 @@
+=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 CreateWebInputRequest
+    # Unique identifier for the Web Input.
+    attr_accessor :id
+
+    # Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).
+    attr_accessor :created_at
+
+    # The URL for the Web Input to load.
+    attr_accessor :url
+
+    # When set to `true` the Web Input will automatically launch and start streaming immediately after creation
+    attr_accessor :auto_launch
+
+    # The Live Stream ID to broadcast this Web Input to
+    attr_accessor :live_stream_id
+
+    attr_accessor :status
+
+    # Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. **Max: 255 characters**.
+    attr_accessor :passthrough
+
+    # The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set.
+    attr_accessor :resolution
+
+    # The number of seconds that the Web Input should stream for before automatically shutting down.
+    attr_accessor :timeout
+
+    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
+      {
+        :'id' => :'id',
+        :'created_at' => :'created_at',
+        :'url' => :'url',
+        :'auto_launch' => :'auto_launch',
+        :'live_stream_id' => :'live_stream_id',
+        :'status' => :'status',
+        :'passthrough' => :'passthrough',
+        :'resolution' => :'resolution',
+        :'timeout' => :'timeout'
+      }
+    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',
+        :'created_at' => :'String',
+        :'url' => :'String',
+        :'auto_launch' => :'Boolean',
+        :'live_stream_id' => :'String',
+        :'status' => :'String',
+        :'passthrough' => :'String',
+        :'resolution' => :'String',
+        :'timeout' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'WebInput'
+      ]
+    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::CreateWebInputRequest` 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::CreateWebInputRequest`. 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
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'auto_launch')
+        self.auto_launch = attributes[:'auto_launch']
+      end
+
+      if attributes.key?(:'live_stream_id')
+        self.live_stream_id = attributes[:'live_stream_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
+      end
+
+      if attributes.key?(:'resolution')
+        self.resolution = attributes[:'resolution']
+      else
+        self.resolution = '1920x1080'
+      end
+
+      if attributes.key?(:'timeout')
+        self.timeout = attributes[:'timeout']
+      else
+        self.timeout = 3600
+      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?
+      status_validator = EnumAttributeValidator.new('String', ["idle", "launching", "streaming"])
+      return false unless status_validator.valid?(@status)
+      resolution_validator = EnumAttributeValidator.new('String', ["1920x1080", "1280x720", "1080x1920", "720x1280", "1080x1080", "720x720"])
+      return false unless resolution_validator.valid?(@resolution)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["idle", "launching", "streaming"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] resolution Object to be assigned
+    def resolution=(resolution)
+      validator = EnumAttributeValidator.new('String', ["1920x1080", "1280x720", "1080x1920", "720x1280", "1080x1080", "720x720"])
+      unless validator.valid?(resolution)
+        fail ArgumentError, "invalid value for \"resolution\", must be one of #{validator.allowable_values}."
+      end
+      @resolution = resolution
+    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 &&
+          created_at == o.created_at &&
+          url == o.url &&
+          auto_launch == o.auto_launch &&
+          live_stream_id == o.live_stream_id &&
+          status == o.status &&
+          passthrough == o.passthrough &&
+          resolution == o.resolution &&
+          timeout == o.timeout
+    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, created_at, url, auto_launch, live_stream_id, status, passthrough, resolution, timeout].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/dimension_value.rb

@@ -43,6 +43,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'value',
       ])
     end
 

data/lib/mux_ruby/models/error.rb

@@ -33,7 +33,7 @@ module MuxRuby
     # Description of the error.
     attr_accessor :description
 
-    # The total number of views that experiend this error.
+    # The total number of views that experienced this error.
     attr_accessor :count
 
     # The error code
@@ -75,6 +75,10 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'notes',
+        :'message',
+        :'description',
+        :'code'
       ])
     end
 

data/lib/mux_ruby/models/filter_value.rb

@@ -43,6 +43,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'value',
       ])
     end
 

data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb

@@ -21,12 +21,15 @@ module MuxRuby
 
     attr_accessor :timeframe
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'data' => :'data',
         :'total_row_count' => :'total_row_count',
-        :'timeframe' => :'timeframe'
+        :'timeframe' => :'timeframe',
+        :'meta' => :'meta'
       }
     end
 
@@ -40,7 +43,8 @@ module MuxRuby
       {
         :'data' => :'Array<Array<String>>',
         :'total_row_count' => :'Integer',
-        :'timeframe' => :'Array<Integer>'
+        :'timeframe' => :'Array<Integer>',
+        :'meta' => :'ListBreakdownValuesResponseMeta'
       }
     end
 
@@ -80,6 +84,10 @@ module MuxRuby
           self.timeframe = value
         end
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -102,7 +110,8 @@ module MuxRuby
       self.class == o.class &&
           data == o.data &&
           total_row_count == o.total_row_count &&
-          timeframe == o.timeframe
+          timeframe == o.timeframe &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -114,7 +123,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data, total_row_count, timeframe].hash
+      [data, total_row_count, timeframe, meta].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/get_monitoring_breakdown_response.rb

@@ -47,6 +47,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 

data/lib/mux_ruby/models/get_monitoring_breakdown_timeseries_response.rb

@@ -47,6 +47,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 

data/lib/mux_ruby/models/get_monitoring_histogram_timeseries_response.rb

@@ -51,6 +51,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 

data/lib/mux_ruby/models/get_monitoring_histogram_timeseries_response_meta.rb

@@ -15,11 +15,14 @@ require 'time'
 
 module MuxRuby
   class GetMonitoringHistogramTimeseriesResponseMeta
+    attr_accessor :bucket_unit
+
     attr_accessor :buckets
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'bucket_unit' => :'bucket_unit',
         :'buckets' => :'buckets'
       }
     end
@@ -32,6 +35,7 @@ module MuxRuby
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'bucket_unit' => :'String',
         :'buckets' => :'Array<MonitoringHistogramTimeseriesBucket>'
       }
     end
@@ -57,6 +61,10 @@ module MuxRuby
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'bucket_unit')
+        self.bucket_unit = attributes[:'bucket_unit']
+      end
+
       if attributes.key?(:'buckets')
         if (value = attributes[:'buckets']).is_a?(Array)
           self.buckets = value
@@ -82,6 +90,7 @@ module MuxRuby
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          bucket_unit == o.bucket_unit &&
           buckets == o.buckets
     end
 
@@ -94,7 +103,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [buckets].hash
+      [bucket_unit, buckets].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/get_monitoring_timeseries_response.rb

@@ -47,6 +47,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 

data/lib/mux_ruby/models/get_overall_values_response.rb

@@ -21,12 +21,15 @@ module MuxRuby
 
     attr_accessor :timeframe
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'data' => :'data',
         :'total_row_count' => :'total_row_count',
-        :'timeframe' => :'timeframe'
+        :'timeframe' => :'timeframe',
+        :'meta' => :'meta'
       }
     end
 
@@ -40,13 +43,15 @@ module MuxRuby
       {
         :'data' => :'OverallValues',
         :'total_row_count' => :'Integer',
-        :'timeframe' => :'Array<Integer>'
+        :'timeframe' => :'Array<Integer>',
+        :'meta' => :'ListBreakdownValuesResponseMeta'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 
@@ -78,6 +83,10 @@ module MuxRuby
           self.timeframe = value
         end
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +109,8 @@ module MuxRuby
       self.class == o.class &&
           data == o.data &&
           total_row_count == o.total_row_count &&
-          timeframe == o.timeframe
+          timeframe == o.timeframe &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -112,7 +122,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data, total_row_count, timeframe].hash
+      [data, total_row_count, timeframe, meta].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/get_real_time_breakdown_response.rb

@@ -47,6 +47,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end
 

data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb

@@ -51,6 +51,7 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_row_count',
       ])
     end