mux_ruby 5.0.1 → 5.1.0

data/lib/mux_ruby/models/asset_progress.rb

@@ -0,0 +1,288 @@
+=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
+  # Detailed state information about the asset ingest process.
+  class AssetProgress
+    # The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input).  - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. 
+    attr_accessor :state
+
+    # Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
+    attr_accessor :progress
+
+    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
+      {
+        :'state' => :'state',
+        :'progress' => :'progress'
+      }
+    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
+      {
+        :'state' => :'String',
+        :'progress' => :'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::AssetProgress` 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::AssetProgress`. 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?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'progress')
+        self.progress = attributes[:'progress']
+      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 !@progress.nil? && @progress > 100
+        invalid_properties.push('invalid value for "progress", must be smaller than or equal to 100.')
+      end
+
+      if !@progress.nil? && @progress < -1
+        invalid_properties.push('invalid value for "progress", must be greater than or equal to -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?
+      state_validator = EnumAttributeValidator.new('String', ["ingesting", "transcoding", "completed", "live", "errored"])
+      return false unless state_validator.valid?(@state)
+      return false if !@progress.nil? && @progress > 100
+      return false if !@progress.nil? && @progress < -1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["ingesting", "transcoding", "completed", "live", "errored"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] progress Value to be assigned
+    def progress=(progress)
+      if !progress.nil? && progress > 100
+        fail ArgumentError, 'invalid value for "progress", must be smaller than or equal to 100.'
+      end
+
+      if !progress.nil? && progress < -1
+        fail ArgumentError, 'invalid value for "progress", must be greater than or equal to -1.'
+      end
+
+      @progress = progress
+    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 &&
+          state == o.state &&
+          progress == o.progress
+    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
+      [state, progress].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/create_asset_request.rb

@@ -61,6 +61,9 @@ module MuxRuby
 
     attr_accessor :meta
 
+    # If the created asset is a clip, this controls whether overlays are copied from the source asset.
+    attr_accessor :copy_overlays
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -101,7 +104,8 @@ module MuxRuby
         :'encoding_tier' => :'encoding_tier',
         :'video_quality' => :'video_quality',
         :'static_renditions' => :'static_renditions',
-        :'meta' => :'meta'
+        :'meta' => :'meta',
+        :'copy_overlays' => :'copy_overlays'
       }
     end
 
@@ -128,7 +132,8 @@ module MuxRuby
         :'encoding_tier' => :'String',
         :'video_quality' => :'String',
         :'static_renditions' => :'Array<CreateStaticRenditionRequest>',
-        :'meta' => :'AssetMetadata'
+        :'meta' => :'AssetMetadata',
+        :'copy_overlays' => :'Boolean'
       }
     end
 
@@ -230,6 +235,12 @@ module MuxRuby
       if attributes.key?(:'meta')
         self.meta = attributes[:'meta']
       end
+
+      if attributes.key?(:'copy_overlays')
+        self.copy_overlays = attributes[:'copy_overlays']
+      else
+        self.copy_overlays = true
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -325,7 +336,8 @@ module MuxRuby
           encoding_tier == o.encoding_tier &&
           video_quality == o.video_quality &&
           static_renditions == o.static_renditions &&
-          meta == o.meta
+          meta == o.meta &&
+          copy_overlays == o.copy_overlays
     end
 
     # @see the `==` method
@@ -337,7 +349,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [input, inputs, playback_policy, playback_policies, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier, video_quality, static_renditions, meta].hash
+      [input, inputs, playback_policy, playback_policies, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier, video_quality, static_renditions, meta, copy_overlays].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_live_stream_request.rb

@@ -63,6 +63,8 @@ module MuxRuby
     # The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.
     attr_accessor :max_continuous_duration
 
+    attr_accessor :meta
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -104,7 +106,8 @@ module MuxRuby
         :'latency_mode' => :'latency_mode',
         :'test' => :'test',
         :'simulcast_targets' => :'simulcast_targets',
-        :'max_continuous_duration' => :'max_continuous_duration'
+        :'max_continuous_duration' => :'max_continuous_duration',
+        :'meta' => :'meta'
       }
     end
 
@@ -132,7 +135,8 @@ module MuxRuby
         :'latency_mode' => :'String',
         :'test' => :'Boolean',
         :'simulcast_targets' => :'Array<CreateSimulcastTargetRequest>',
-        :'max_continuous_duration' => :'Integer'
+        :'max_continuous_duration' => :'Integer',
+        :'meta' => :'LiveStreamMetadata'
       }
     end
 
@@ -242,6 +246,10 @@ module MuxRuby
       else
         self.max_continuous_duration = 43200
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -338,7 +346,8 @@ module MuxRuby
           latency_mode == o.latency_mode &&
           test == o.test &&
           simulcast_targets == o.simulcast_targets &&
-          max_continuous_duration == o.max_continuous_duration
+          max_continuous_duration == o.max_continuous_duration &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -350,7 +359,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [playback_policy, playback_policies, advanced_playback_policies, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration].hash
+      [playback_policy, playback_policies, advanced_playback_policies, new_asset_settings, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, passthrough, audio_only, embedded_subtitles, generated_subtitles, reduced_latency, low_latency, latency_mode, test, simulcast_targets, max_continuous_duration, meta].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/list_annotations_response.rb

@@ -0,0 +1,266 @@
+=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 ListAnnotationsResponse
+    attr_accessor :data
+
+    # Total number of annotations available
+    attr_accessor :total_row_count
+
+    # Start and end unix timestamps for the data range
+    attr_accessor :timeframe
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'total_row_count' => :'total_row_count',
+        :'timeframe' => :'timeframe'
+      }
+    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' => :'Array<Annotation>',
+        :'total_row_count' => :'Integer',
+        :'timeframe' => :'Array<Integer>'
+      }
+    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::ListAnnotationsResponse` 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::ListAnnotationsResponse`. 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')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'total_row_count')
+        self.total_row_count = attributes[:'total_row_count']
+      end
+
+      if attributes.key?(:'timeframe')
+        if (value = attributes[:'timeframe']).is_a?(Array)
+          self.timeframe = 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
+      if !@timeframe.nil? && @timeframe.length > 2
+        invalid_properties.push('invalid value for "timeframe", number of items must be less than or equal to 2.')
+      end
+
+      if !@timeframe.nil? && @timeframe.length < 2
+        invalid_properties.push('invalid value for "timeframe", number of items must be greater than or equal to 2.')
+      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 !@timeframe.nil? && @timeframe.length > 2
+      return false if !@timeframe.nil? && @timeframe.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timeframe Value to be assigned
+    def timeframe=(timeframe)
+      if !timeframe.nil? && timeframe.length > 2
+        fail ArgumentError, 'invalid value for "timeframe", number of items must be less than or equal to 2.'
+      end
+
+      if !timeframe.nil? && timeframe.length < 2
+        fail ArgumentError, 'invalid value for "timeframe", number of items must be greater than or equal to 2.'
+      end
+
+      @timeframe = timeframe
+    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 &&
+          total_row_count == o.total_row_count &&
+          timeframe == o.timeframe
+    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, total_row_count, timeframe].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