mux_ruby 3.1.0 → 3.2.0

data/lib/mux_ruby/models/update_live_stream_request.rb

@@ -0,0 +1,297 @@
+=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 UpdateLiveStreamRequest
+    # Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.
+    attr_accessor :passthrough
+
+    # 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. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/
+    attr_accessor :latency_mode
+
+    # When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset.
+    attr_accessor :reconnect_window
+
+    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
+      {
+        :'passthrough' => :'passthrough',
+        :'latency_mode' => :'latency_mode',
+        :'reconnect_window' => :'reconnect_window'
+      }
+    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
+      {
+        :'passthrough' => :'String',
+        :'latency_mode' => :'String',
+        :'reconnect_window' => :'Float'
+      }
+    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::UpdateLiveStreamRequest` 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::UpdateLiveStreamRequest`. 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?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
+      end
+
+      if attributes.key?(:'latency_mode')
+        self.latency_mode = attributes[:'latency_mode']
+      end
+
+      if attributes.key?(:'reconnect_window')
+        self.reconnect_window = attributes[:'reconnect_window']
+      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
+      if !@reconnect_window.nil? && @reconnect_window > 300
+        invalid_properties.push('invalid value for "reconnect_window", must be smaller than or equal to 300.')
+      end
+
+      if !@reconnect_window.nil? && @reconnect_window < 0.1
+        invalid_properties.push('invalid value for "reconnect_window", must be greater than or equal to 0.1.')
+      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?
+      latency_mode_validator = EnumAttributeValidator.new('String', ["low", "reduced", "standard"])
+      return false unless latency_mode_validator.valid?(@latency_mode)
+      return false if !@reconnect_window.nil? && @reconnect_window > 300
+      return false if !@reconnect_window.nil? && @reconnect_window < 0.1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] latency_mode Object to be assigned
+    def latency_mode=(latency_mode)
+      validator = EnumAttributeValidator.new('String', ["low", "reduced", "standard"])
+      unless validator.valid?(latency_mode)
+        fail ArgumentError, "invalid value for \"latency_mode\", must be one of #{validator.allowable_values}."
+      end
+      @latency_mode = latency_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reconnect_window Value to be assigned
+    def reconnect_window=(reconnect_window)
+      if !reconnect_window.nil? && reconnect_window > 300
+        fail ArgumentError, 'invalid value for "reconnect_window", must be smaller than or equal to 300.'
+      end
+
+      if !reconnect_window.nil? && reconnect_window < 0.1
+        fail ArgumentError, 'invalid value for "reconnect_window", must be greater than or equal to 0.1.'
+      end
+
+      @reconnect_window = reconnect_window
+    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 &&
+          passthrough == o.passthrough &&
+          latency_mode == o.latency_mode &&
+          reconnect_window == o.reconnect_window
+    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
+      [passthrough, latency_mode, reconnect_window].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/update_referrer_domain_restriction_request.rb

@@ -0,0 +1,209 @@
+=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 UpdateReferrerDomainRestrictionRequest
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::UpdateReferrerDomainRestrictionRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::UpdateReferrerDomainRestrictionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          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 = '3.1.0'
+  VERSION = '3.2.0'
 end

data/lib/mux_ruby.rb

@@ -31,6 +31,7 @@ require 'mux_ruby/models/create_asset_request'
 require 'mux_ruby/models/create_live_stream_request'
 require 'mux_ruby/models/create_playback_id_request'
 require 'mux_ruby/models/create_playback_id_response'
+require 'mux_ruby/models/create_playback_restriction_request'
 require 'mux_ruby/models/create_simulcast_target_request'
 require 'mux_ruby/models/create_track_request'
 require 'mux_ruby/models/create_track_response'
@@ -96,11 +97,14 @@ require 'mux_ruby/models/notification_rule'
 require 'mux_ruby/models/overall_values'
 require 'mux_ruby/models/playback_id'
 require 'mux_ruby/models/playback_policy'
+require 'mux_ruby/models/playback_restriction'
+require 'mux_ruby/models/playback_restriction_response'
 require 'mux_ruby/models/real_time_breakdown_value'
 require 'mux_ruby/models/real_time_histogram_timeseries_bucket'
 require 'mux_ruby/models/real_time_histogram_timeseries_bucket_values'
 require 'mux_ruby/models/real_time_histogram_timeseries_datapoint'
 require 'mux_ruby/models/real_time_timeseries_datapoint'
+require 'mux_ruby/models/referrer_domain_restriction'
 require 'mux_ruby/models/score'
 require 'mux_ruby/models/signal_live_stream_complete_response'
 require 'mux_ruby/models/signing_key'
@@ -110,7 +114,10 @@ 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_asset_request'
 require 'mux_ruby/models/update_live_stream_embedded_subtitles_request'
+require 'mux_ruby/models/update_live_stream_request'
+require 'mux_ruby/models/update_referrer_domain_restriction_request'
 require 'mux_ruby/models/upload'
 require 'mux_ruby/models/upload_error'
 require 'mux_ruby/models/upload_response'
@@ -130,6 +137,7 @@ require 'mux_ruby/api/incidents_api'
 require 'mux_ruby/api/live_streams_api'
 require 'mux_ruby/api/metrics_api'
 require 'mux_ruby/api/playback_id_api'
+require 'mux_ruby/api/playback_restrictions_api'
 require 'mux_ruby/api/real_time_api'
 require 'mux_ruby/api/url_signing_keys_api'
 require 'mux_ruby/api/video_views_api'

data/spec/api/playback_restrictions_api_spec.rb

@@ -0,0 +1,97 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for MuxRuby::PlaybackRestrictionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PlaybackRestrictionsApi' do
+  before do
+    # run before each test
+    @api_instance = MuxRuby::PlaybackRestrictionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PlaybackRestrictionsApi' do
+    it 'should create an instance of PlaybackRestrictionsApi' do
+      expect(@api_instance).to be_instance_of(MuxRuby::PlaybackRestrictionsApi)
+    end
+  end
+
+  # unit tests for create_playback_restriction
+  # Create a Playback Restriction
+  # Create a new Playback Restriction.
+  # @param create_playback_restriction_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PlaybackRestriction]
+  describe 'create_playback_restriction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_playback_restriction
+  # Delete a Playback Restriction
+  # Deletes a single Playback Restriction.
+  # @param playback_restriction_id ID of the Playback Restriction.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_playback_restriction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_playback_restriction
+  # Retrieve a Playback Restriction
+  # Retrieves a Playback Restriction associated with the unique identifier.
+  # @param playback_restriction_id ID of the Playback Restriction.
+  # @param [Hash] opts the optional parameters
+  # @return [PlaybackRestriction]
+  describe 'get_playback_restriction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_playback_restrictions
+  # List Playback Restrictions
+  # Returns a list of all Playback Restrictions.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Offset by this many pages, of the size of `limit`
+  # @option opts [Integer] :limit Number of items to include in the response
+  # @return [Array<PlaybackRestriction>]
+  describe 'list_playback_restrictions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_referrer_domain_restriction
+  # Update the Referrer Playback Restriction
+  # Allows you to modify the list of domians or change how Mux validates playback requests without the &#x60;Referer&#x60; HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
+  # @param playback_restriction_id ID of the Playback Restriction.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [PlaybackRestriction]
+  describe 'update_referrer_domain_restriction test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/create_playback_restriction_request_spec.rb

@@ -0,0 +1,34 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MuxRuby::CreatePlaybackRestrictionRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MuxRuby::CreatePlaybackRestrictionRequest do
+  let(:instance) { MuxRuby::CreatePlaybackRestrictionRequest.new }
+
+  describe 'test an instance of CreatePlaybackRestrictionRequest' do
+    it 'should create an instance of CreatePlaybackRestrictionRequest' do
+      expect(instance).to be_instance_of(MuxRuby::CreatePlaybackRestrictionRequest)
+    end
+  end
+  describe 'test attribute "referrer"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end