mux_ruby 4.0.0 → 5.0.0

data/lib/mux_ruby/models/asset_metadata.rb

@@ -0,0 +1,284 @@
+=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 AssetMetadata
+    # The video title. Max 512 code points.
+    attr_accessor :title
+
+    # This is an identifier you provide to keep track of the creator of the video. Max 128 code points.
+    attr_accessor :creator_id
+
+    # This is an identifier you provide to link the video to your own data. Max 128 code points.
+    attr_accessor :external_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title' => :'title',
+        :'creator_id' => :'creator_id',
+        :'external_id' => :'external_id'
+      }
+    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
+      {
+        :'title' => :'String',
+        :'creator_id' => :'String',
+        :'external_id' => :'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::AssetMetadata` 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::AssetMetadata`. 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?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'creator_id')
+        self.creator_id = attributes[:'creator_id']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      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 !@title.nil? && @title.to_s.length > 512
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@creator_id.nil? && @creator_id.to_s.length > 128
+        invalid_properties.push('invalid value for "creator_id", the character length must be smaller than or equal to 128.')
+      end
+
+      if !@external_id.nil? && @external_id.to_s.length > 128
+        invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 128.')
+      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 !@title.nil? && @title.to_s.length > 512
+      return false if !@creator_id.nil? && @creator_id.to_s.length > 128
+      return false if !@external_id.nil? && @external_id.to_s.length > 128
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if !title.nil? && title.to_s.length > 512
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 512.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creator_id Value to be assigned
+    def creator_id=(creator_id)
+      if !creator_id.nil? && creator_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "creator_id", the character length must be smaller than or equal to 128.'
+      end
+
+      @creator_id = creator_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] external_id Value to be assigned
+    def external_id=(external_id)
+      if !external_id.nil? && external_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 128.'
+      end
+
+      @external_id = external_id
+    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 &&
+          title == o.title &&
+          creator_id == o.creator_id &&
+          external_id == o.external_id
+    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
+      [title, creator_id, external_id].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

@@ -15,18 +15,24 @@ require 'time'
 
 module MuxRuby
   class CreateAssetRequest
-    # An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements.
+    # Deprecated. Use `inputs` instead, which accepts an identical type.
     attr_accessor :input
 
-    # An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include:  * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset).  If no `playback_policy` is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. 
+    # An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements.
+    attr_accessor :inputs
+
+    # Deprecated. Use `playback_policies` instead, which accepts an identical type.
     attr_accessor :playback_policy
 
-    # An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. 
+    # An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include:  * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset).  If no `playback_policies` are set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. 
+    attr_accessor :playback_policies
+
+    # An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policies` when creating a DRM playback ID. 
     attr_accessor :advanced_playback_policies
 
     attr_accessor :per_title_encode
 
-    # Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**.
+    # You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id`, you can use the `meta` object instead. **Max: 255 characters**.
     attr_accessor :passthrough
 
     # Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) for the updated API.  Specify what level of support for mp4 playback. You may not enable both `mp4_support` and  `static_renditions`.  * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset.  The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset).  MP4 files are not produced for `none` (default).  In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. 
@@ -53,6 +59,8 @@ module MuxRuby
     # An array of static renditions to create for this asset. You may not enable both `static_renditions` and `mp4_support (the latter being deprecated)`
     attr_accessor :static_renditions
 
+    attr_accessor :meta
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -79,7 +87,9 @@ module MuxRuby
     def self.attribute_map
       {
         :'input' => :'input',
+        :'inputs' => :'inputs',
         :'playback_policy' => :'playback_policy',
+        :'playback_policies' => :'playback_policies',
         :'advanced_playback_policies' => :'advanced_playback_policies',
         :'per_title_encode' => :'per_title_encode',
         :'passthrough' => :'passthrough',
@@ -90,7 +100,8 @@ module MuxRuby
         :'max_resolution_tier' => :'max_resolution_tier',
         :'encoding_tier' => :'encoding_tier',
         :'video_quality' => :'video_quality',
-        :'static_renditions' => :'static_renditions'
+        :'static_renditions' => :'static_renditions',
+        :'meta' => :'meta'
       }
     end
 
@@ -103,7 +114,9 @@ module MuxRuby
     def self.openapi_types
       {
         :'input' => :'Array<InputSettings>',
+        :'inputs' => :'Array<InputSettings>',
         :'playback_policy' => :'Array<PlaybackPolicy>',
+        :'playback_policies' => :'Array<PlaybackPolicy>',
         :'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
         :'per_title_encode' => :'Boolean',
         :'passthrough' => :'String',
@@ -114,7 +127,8 @@ module MuxRuby
         :'max_resolution_tier' => :'String',
         :'encoding_tier' => :'String',
         :'video_quality' => :'String',
-        :'static_renditions' => :'Array<CreateStaticRenditionRequest>'
+        :'static_renditions' => :'Array<CreateStaticRenditionRequest>',
+        :'meta' => :'AssetMetadata'
       }
     end
 
@@ -145,12 +159,24 @@ module MuxRuby
         end
       end
 
+      if attributes.key?(:'inputs')
+        if (value = attributes[:'inputs']).is_a?(Array)
+          self.inputs = value
+        end
+      end
+
       if attributes.key?(:'playback_policy')
         if (value = attributes[:'playback_policy']).is_a?(Array)
           self.playback_policy = value
         end
       end
 
+      if attributes.key?(:'playback_policies')
+        if (value = attributes[:'playback_policies']).is_a?(Array)
+          self.playback_policies = value
+        end
+      end
+
       if attributes.key?(:'advanced_playback_policies')
         if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
           self.advanced_playback_policies = value
@@ -200,6 +226,10 @@ module MuxRuby
           self.static_renditions = value
         end
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -281,7 +311,9 @@ module MuxRuby
       return true if self.equal?(o)
       self.class == o.class &&
           input == o.input &&
+          inputs == o.inputs &&
           playback_policy == o.playback_policy &&
+          playback_policies == o.playback_policies &&
           advanced_playback_policies == o.advanced_playback_policies &&
           per_title_encode == o.per_title_encode &&
           passthrough == o.passthrough &&
@@ -292,7 +324,8 @@ module MuxRuby
           max_resolution_tier == o.max_resolution_tier &&
           encoding_tier == o.encoding_tier &&
           video_quality == o.video_quality &&
-          static_renditions == o.static_renditions
+          static_renditions == o.static_renditions &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -304,7 +337,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [input, playback_policy, advanced_playback_policies, per_title_encode, passthrough, mp4_support, normalize_audio, master_access, test, max_resolution_tier, encoding_tier, video_quality, static_renditions].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
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/create_live_stream_request.rb

@@ -15,9 +15,13 @@ require 'time'
 
 module MuxRuby
   class CreateLiveStreamRequest
+    # Deprecated. Use `playback_policies` instead, which accepts an identical type.
     attr_accessor :playback_policy
 
-    # An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. 
+    # An array of playback policy names that you want applied to this live stream and available through `playback_ids`. Options include:  * `\"public\"` (anyone with the playback URL can stream the live stream). * `\"signed\"` (an additional access token is required to play the live stream).  If no `playback_policies` is set, the live stream will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. 
+    attr_accessor :playback_policies
+
+    # An array of playback policy objects that you want applied on this live stream and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policies` when creating a DRM playback ID. 
     attr_accessor :advanced_playback_policies
 
     attr_accessor :new_asset_settings
@@ -85,6 +89,7 @@ module MuxRuby
     def self.attribute_map
       {
         :'playback_policy' => :'playback_policy',
+        :'playback_policies' => :'playback_policies',
         :'advanced_playback_policies' => :'advanced_playback_policies',
         :'new_asset_settings' => :'new_asset_settings',
         :'reconnect_window' => :'reconnect_window',
@@ -112,6 +117,7 @@ module MuxRuby
     def self.openapi_types
       {
         :'playback_policy' => :'Array<PlaybackPolicy>',
+        :'playback_policies' => :'Array<PlaybackPolicy>',
         :'advanced_playback_policies' => :'Array<CreatePlaybackIDRequest>',
         :'new_asset_settings' => :'CreateAssetRequest',
         :'reconnect_window' => :'Float',
@@ -157,6 +163,12 @@ module MuxRuby
         end
       end
 
+      if attributes.key?(:'playback_policies')
+        if (value = attributes[:'playback_policies']).is_a?(Array)
+          self.playback_policies = value
+        end
+      end
+
       if attributes.key?(:'advanced_playback_policies')
         if (value = attributes[:'advanced_playback_policies']).is_a?(Array)
           self.advanced_playback_policies = value
@@ -311,6 +323,7 @@ module MuxRuby
       return true if self.equal?(o)
       self.class == o.class &&
           playback_policy == o.playback_policy &&
+          playback_policies == o.playback_policies &&
           advanced_playback_policies == o.advanced_playback_policies &&
           new_asset_settings == o.new_asset_settings &&
           reconnect_window == o.reconnect_window &&
@@ -337,7 +350,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [playback_policy, 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].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/update_asset_request.rb

@@ -15,13 +15,16 @@ require 'time'
 
 module MuxRuby
   class UpdateAssetRequest
-    # Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this value, the field should be included with an empty string value.
+    # You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**. In order to clear this value, the field should be included with an empty string value.
     attr_accessor :passthrough
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'passthrough' => :'passthrough'
+        :'passthrough' => :'passthrough',
+        :'meta' => :'meta'
       }
     end
 
@@ -33,7 +36,8 @@ module MuxRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'passthrough' => :'String'
+        :'passthrough' => :'String',
+        :'meta' => :'AssetMetadata'
       }
     end
 
@@ -61,6 +65,10 @@ module MuxRuby
       if attributes.key?(:'passthrough')
         self.passthrough = attributes[:'passthrough']
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -81,7 +89,8 @@ module MuxRuby
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          passthrough == o.passthrough
+          passthrough == o.passthrough &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -93,7 +102,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [passthrough].hash
+      [passthrough, meta].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb

@@ -25,6 +25,8 @@ module MuxRuby
     # The video quality controls the cost, quality, and available platform features for the asset. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)
     attr_accessor :video_quality
 
+    attr_accessor :meta
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -52,7 +54,8 @@ module MuxRuby
       {
         :'mp4_support' => :'mp4_support',
         :'master_access' => :'master_access',
-        :'video_quality' => :'video_quality'
+        :'video_quality' => :'video_quality',
+        :'meta' => :'meta'
       }
     end
 
@@ -66,7 +69,8 @@ module MuxRuby
       {
         :'mp4_support' => :'String',
         :'master_access' => :'String',
-        :'video_quality' => :'String'
+        :'video_quality' => :'String',
+        :'meta' => :'AssetMetadata'
       }
     end
 
@@ -102,6 +106,10 @@ module MuxRuby
       if attributes.key?(:'video_quality')
         self.video_quality = attributes[:'video_quality']
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -160,7 +168,8 @@ module MuxRuby
       self.class == o.class &&
           mp4_support == o.mp4_support &&
           master_access == o.master_access &&
-          video_quality == o.video_quality
+          video_quality == o.video_quality &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -172,7 +181,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mp4_support, master_access, video_quality].hash
+      [mp4_support, master_access, video_quality, meta].hash
     end
 
     # Builds the object from hash