mux_ruby 3.20.0 → 5.0.0

data/lib/mux_ruby/models/{asset_static_renditions_files.rb → static_rendition.rb}

@@ -14,7 +14,8 @@ require 'date'
 require 'time'
 
 module MuxRuby
-  class AssetStaticRenditionsFiles
+  class StaticRendition
+    # Name of the static rendition file
     attr_accessor :name
 
     # Extension of the static rendition file
@@ -32,6 +33,24 @@ module MuxRuby
     # The file size in bytes
     attr_accessor :filesize
 
+    # Indicates the static rendition type of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`.
+    attr_accessor :type
+
+    # Indicates the status of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested 
+    attr_accessor :status
+
+    # Indicates the resolution tier of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`.
+    attr_accessor :resolution_tier
+
+    # Indicates the resolution of this specific MP4 version of this asset. This field is only valid for `static_renditions`, not for `mp4_support`.
+    attr_accessor :resolution
+
+    # The ID of this static rendition, used in managing this static rendition. This field is only valid for `static_renditions`, not for `mp4_support`.
+    attr_accessor :id
+
+    # Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
+    attr_accessor :passthrough
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -62,7 +81,13 @@ module MuxRuby
         :'height' => :'height',
         :'width' => :'width',
         :'bitrate' => :'bitrate',
-        :'filesize' => :'filesize'
+        :'filesize' => :'filesize',
+        :'type' => :'type',
+        :'status' => :'status',
+        :'resolution_tier' => :'resolution_tier',
+        :'resolution' => :'resolution',
+        :'id' => :'id',
+        :'passthrough' => :'passthrough'
       }
     end
 
@@ -79,7 +104,13 @@ module MuxRuby
         :'height' => :'Integer',
         :'width' => :'Integer',
         :'bitrate' => :'Integer',
-        :'filesize' => :'String'
+        :'filesize' => :'String',
+        :'type' => :'String',
+        :'status' => :'String',
+        :'resolution_tier' => :'String',
+        :'resolution' => :'String',
+        :'id' => :'String',
+        :'passthrough' => :'String'
       }
     end
 
@@ -93,13 +124,13 @@ module MuxRuby
     # @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::AssetStaticRenditionsFiles` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::StaticRendition` 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::AssetStaticRenditionsFiles`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::StaticRendition`. 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
       }
@@ -127,6 +158,30 @@ module MuxRuby
       if attributes.key?(:'filesize')
         self.filesize = attributes[:'filesize']
       end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'resolution_tier')
+        self.resolution_tier = attributes[:'resolution_tier']
+      end
+
+      if attributes.key?(:'resolution')
+        self.resolution = attributes[:'resolution']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,17 +194,25 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      name_validator = EnumAttributeValidator.new('String', ["low.mp4", "medium.mp4", "high.mp4", "audio.m4a", "capped-1080p.mp4"])
+      name_validator = EnumAttributeValidator.new('String', ["low.mp4", "medium.mp4", "high.mp4", "highest.mp4", "audio.m4a", "capped-1080p.mp4", "2160p.mp4", "1440p.mp4", "1080p.mp4", "720p.mp4", "540p.mp4", "480p.mp4", "360p.mp4", "270p.mp4"])
       return false unless name_validator.valid?(@name)
       ext_validator = EnumAttributeValidator.new('String', ["mp4", "m4a"])
       return false unless ext_validator.valid?(@ext)
+      type_validator = EnumAttributeValidator.new('String', ["standard", "advanced"])
+      return false unless type_validator.valid?(@type)
+      status_validator = EnumAttributeValidator.new('String', ["ready", "preparing", "skipped", "errored"])
+      return false unless status_validator.valid?(@status)
+      resolution_tier_validator = EnumAttributeValidator.new('String', ["2160p", "1440p", "1080p", "720p"])
+      return false unless resolution_tier_validator.valid?(@resolution_tier)
+      resolution_validator = EnumAttributeValidator.new('String', ["highest", "audio-only", "2160p", "1440p", "1080p", "720p", "540p", "480p", "360p", "270p"])
+      return false unless resolution_validator.valid?(@resolution)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] name Object to be assigned
     def name=(name)
-      validator = EnumAttributeValidator.new('String', ["low.mp4", "medium.mp4", "high.mp4", "audio.m4a", "capped-1080p.mp4"])
+      validator = EnumAttributeValidator.new('String', ["low.mp4", "medium.mp4", "high.mp4", "highest.mp4", "audio.m4a", "capped-1080p.mp4", "2160p.mp4", "1440p.mp4", "1080p.mp4", "720p.mp4", "540p.mp4", "480p.mp4", "360p.mp4", "270p.mp4"])
       unless validator.valid?(name)
         fail ArgumentError, "invalid value for \"name\", must be one of #{validator.allowable_values}."
       end
@@ -166,6 +229,46 @@ module MuxRuby
       @ext = ext
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["standard", "advanced"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["ready", "preparing", "skipped", "errored"])
+      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_tier Object to be assigned
+    def resolution_tier=(resolution_tier)
+      validator = EnumAttributeValidator.new('String', ["2160p", "1440p", "1080p", "720p"])
+      unless validator.valid?(resolution_tier)
+        fail ArgumentError, "invalid value for \"resolution_tier\", must be one of #{validator.allowable_values}."
+      end
+      @resolution_tier = resolution_tier
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] resolution Object to be assigned
+    def resolution=(resolution)
+      validator = EnumAttributeValidator.new('String', ["highest", "audio-only", "2160p", "1440p", "1080p", "720p", "540p", "480p", "360p", "270p"])
+      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)
@@ -176,7 +279,13 @@ module MuxRuby
           height == o.height &&
           width == o.width &&
           bitrate == o.bitrate &&
-          filesize == o.filesize
+          filesize == o.filesize &&
+          type == o.type &&
+          status == o.status &&
+          resolution_tier == o.resolution_tier &&
+          resolution == o.resolution &&
+          id == o.id &&
+          passthrough == o.passthrough
     end
 
     # @see the `==` method
@@ -188,7 +297,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, ext, height, width, bitrate, filesize].hash
+      [name, ext, height, width, bitrate, filesize, type, status, resolution_tier, resolution, id, passthrough].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

@@ -14,14 +14,19 @@ require 'date'
 require 'time'
 
 module MuxRuby
-  # Updates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support` and `master_access` settings may be updated. 
+  # Updates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support`, `master_access`, and `video_quality` settings may be updated. 
   class UpdateLiveStreamNewAssetSettings
-    # Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * 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). 
+    # Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#during-live-stream-creation) for the updated API. Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * 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). 
     attr_accessor :mp4_support
 
     # Add or remove access to the master version of the video.
     attr_accessor :master_access
 
+    # 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
@@ -48,7 +53,9 @@ module MuxRuby
     def self.attribute_map
       {
         :'mp4_support' => :'mp4_support',
-        :'master_access' => :'master_access'
+        :'master_access' => :'master_access',
+        :'video_quality' => :'video_quality',
+        :'meta' => :'meta'
       }
     end
 
@@ -61,7 +68,9 @@ module MuxRuby
     def self.openapi_types
       {
         :'mp4_support' => :'String',
-        :'master_access' => :'String'
+        :'master_access' => :'String',
+        :'video_quality' => :'String',
+        :'meta' => :'AssetMetadata'
       }
     end
 
@@ -93,6 +102,14 @@ module MuxRuby
       if attributes.key?(:'master_access')
         self.master_access = attributes[:'master_access']
       end
+
+      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?
@@ -109,6 +126,8 @@ module MuxRuby
       return false unless mp4_support_validator.valid?(@mp4_support)
       master_access_validator = EnumAttributeValidator.new('String', ["temporary", "none"])
       return false unless master_access_validator.valid?(@master_access)
+      video_quality_validator = EnumAttributeValidator.new('String', ["plus", "premium"])
+      return false unless video_quality_validator.valid?(@video_quality)
       true
     end
 
@@ -132,13 +151,25 @@ module MuxRuby
       @master_access = master_access
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] video_quality Object to be assigned
+    def video_quality=(video_quality)
+      validator = EnumAttributeValidator.new('String', ["plus", "premium"])
+      unless validator.valid?(video_quality)
+        fail ArgumentError, "invalid value for \"video_quality\", must be one of #{validator.allowable_values}."
+      end
+      @video_quality = video_quality
+    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 &&
           mp4_support == o.mp4_support &&
-          master_access == o.master_access
+          master_access == o.master_access &&
+          video_quality == o.video_quality &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -150,7 +181,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mp4_support, master_access].hash
+      [mp4_support, master_access, video_quality, meta].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/{list_spaces_response.rb → update_live_stream_new_asset_settings_static_renditions_request.rb}

@@ -14,13 +14,13 @@ require 'date'
 require 'time'
 
 module MuxRuby
-  class ListSpacesResponse
-    attr_accessor :data
+  class UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
+    attr_accessor :static_renditions
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'data' => :'data'
+        :'static_renditions' => :'static_renditions'
       }
     end
 
@@ -32,7 +32,7 @@ module MuxRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<Space>'
+        :'static_renditions' => :'Array<CreateStaticRenditionRequest>'
       }
     end
 
@@ -46,20 +46,20 @@ module MuxRuby
     # @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::ListSpacesResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest` 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::ListSpacesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest`. 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
+      if attributes.key?(:'static_renditions')
+        if (value = attributes[:'static_renditions']).is_a?(Array)
+          self.static_renditions = value
         end
       end
     end
@@ -68,17 +68,12 @@ module MuxRuby
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data 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 @data.nil?
       true
     end
 
@@ -87,7 +82,7 @@ module MuxRuby
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          data == o.data
+          static_renditions == o.static_renditions
     end
 
     # @see the `==` method
@@ -99,7 +94,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data].hash
+      [static_renditions].hash
     end
 
     # Builds the object from hash