mux_ruby 1.8.1 → 1.9.0

data/lib/mux_ruby/api/assets_api.rb

@@ -186,6 +186,7 @@ module MuxRuby
     end
 
     # Delete an asset
+    # Deletes a video asset and all its data 
     # @param asset_id The asset ID.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -195,6 +196,7 @@ module MuxRuby
     end
 
     # Delete an asset
+    # Deletes a video asset and all its data 
     # @param asset_id The asset ID.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -505,6 +507,7 @@ module MuxRuby
     end
 
     # List assets
+    # List all Mux assets. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response (default to 25)
     # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
@@ -515,6 +518,7 @@ module MuxRuby
     end
 
     # List assets
+    # List all Mux assets. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response
     # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;

data/lib/mux_ruby/api/playback_id_api.rb

@@ -0,0 +1,69 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'uri'
+
+module MuxRuby
+  class PlaybackIDApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieve an Asset or Live Stream ID
+    # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID. 
+    # @param playback_id The live stream's playback ID.
+    # @param [Hash] opts the optional parameters
+    # @return [GetAssetOrLiveStreamIdResponse]
+    def get_asset_or_livestream_id(playback_id, opts = {})
+      data, _status_code, _headers = get_asset_or_livestream_id_with_http_info(playback_id, opts)
+      data
+    end
+
+    # Retrieve an Asset or Live Stream ID
+    # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID. 
+    # @param playback_id The live stream's playback ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAssetOrLiveStreamIdResponse, Fixnum, Hash)>] GetAssetOrLiveStreamIdResponse data, response status code and response headers
+    def get_asset_or_livestream_id_with_http_info(playback_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaybackIDApi.get_asset_or_livestream_id ...'
+      end
+      # verify the required parameter 'playback_id' is set
+      if @api_client.config.client_side_validation && playback_id.nil?
+        fail ArgumentError, "Missing the required parameter 'playback_id' when calling PlaybackIDApi.get_asset_or_livestream_id"
+      end
+      # resource path
+      local_var_path = '/video/v1/playback-ids/{PLAYBACK_ID}'.sub('{' + 'PLAYBACK_ID' + '}', playback_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetAssetOrLiveStreamIdResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaybackIDApi#get_asset_or_livestream_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end

data/lib/mux_ruby/api_client.rb

@@ -57,33 +57,33 @@ module MuxRuby
         elsif response.code == 401
           fail UnauthorizedError.new(:code => response.code,
                                      :response_headers => response.headers,
-                                    :response_body => response.body),
-            response.status_message
+                                     :response_body => response.body,
+                                     :message => response.status_message)
         elsif response.code == 403
           fail ForbiddenError.new(:code => response.code,
                                   :response_headers => response.headers,
-                                  :response_body => response.body),
-            response.status_message
+                                  :response_body => response.body,
+                                  :message => response.status_message)
         elsif response.code == 404
           fail NotFoundError.new(:code => response.code,
                                  :response_headers => response.headers,
-                                 :response_body => response.body),
-            response.status_message
+                                 :response_body => response.body,
+                                 :message => response.status_message)
         elsif response.code == 429
           fail TooManyRequestsError.new(:code => response.code,
                                  :response_headers => response.headers,
-                                 :response_body => response.body),
-            response.status_message
+                                 :response_body => response.body,
+                                 :message => response.status_message)
         elsif response.code.between?(500, 599)
           fail ServiceError.new(:code => response.code,
                                 :response_headers => response.headers,
-                                :response_body => response.body),
-            response.status_message
+                                :response_body => response.body,
+                                :message => response.status_message)
         else
           fail ApiError.new(:code => response.code,
                             :response_headers => response.headers,
-                            :response_body => response.body),
-            response.status_message
+                            :response_body => response.body,
+                            :message => response.status_message)
         end
       end
 

data/lib/mux_ruby/models/asset.rb

@@ -7,20 +7,27 @@ require 'date'
 
 module MuxRuby
   class Asset
+    # Unique identifier for the Asset.
     attr_accessor :id
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
     attr_accessor :created_at
 
     attr_accessor :deleted_at
 
+    # The status of the asset.
     attr_accessor :status
 
+    # The duration of the asset in seconds (max duration for a single asset is 24 hours).
     attr_accessor :duration
 
+    # The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored.
     attr_accessor :max_stored_resolution
 
+    # The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. 
     attr_accessor :max_stored_frame_rate
 
+    # The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
     attr_accessor :aspect_ratio
 
     attr_accessor :playback_ids
@@ -31,10 +38,13 @@ module MuxRuby
 
     attr_accessor :per_title_encode
 
+    # Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state.
     attr_accessor :is_live
 
+    # Arbitrary metadata set for the asset. Max 255 characters.
     attr_accessor :passthrough
 
+    # Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
     attr_accessor :live_stream_id
 
     attr_accessor :master
@@ -43,6 +53,10 @@ module MuxRuby
 
     attr_accessor :mp4_support
 
+    # Asset Identifier of the video used as the source for creating the clip.
+    attr_accessor :source_asset_id
+
+    # Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
     attr_accessor :normalize_audio
 
     attr_accessor :static_renditions
@@ -52,6 +66,7 @@ module MuxRuby
 
     attr_accessor :non_standard_input_reasons
 
+    # Indicates this asset is a test asset if the value is `true`. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs.
     attr_accessor :test
 
     class EnumAttributeValidator
@@ -97,6 +112,7 @@ module MuxRuby
         :'master' => :'master',
         :'master_access' => :'master_access',
         :'mp4_support' => :'mp4_support',
+        :'source_asset_id' => :'source_asset_id',
         :'normalize_audio' => :'normalize_audio',
         :'static_renditions' => :'static_renditions',
         :'recording_times' => :'recording_times',
@@ -126,6 +142,7 @@ module MuxRuby
         :'master' => :'AssetMaster',
         :'master_access' => :'String',
         :'mp4_support' => :'String',
+        :'source_asset_id' => :'String',
         :'normalize_audio' => :'BOOLEAN',
         :'static_renditions' => :'AssetStaticRenditions',
         :'recording_times' => :'Array<AssetRecordingTimes>',
@@ -222,6 +239,10 @@ module MuxRuby
         self.mp4_support = 'none'
       end
 
+      if attributes.has_key?(:'source_asset_id')
+        self.source_asset_id = attributes[:'source_asset_id']
+      end
+
       if attributes.has_key?(:'normalize_audio')
         self.normalize_audio = attributes[:'normalize_audio']
       else
@@ -257,6 +278,8 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      status_validator = EnumAttributeValidator.new('String', ['preparing', 'ready', 'errored'])
+      return false unless status_validator.valid?(@status)
       max_stored_resolution_validator = EnumAttributeValidator.new('String', ['Audio only', 'SD', 'HD', 'FHD', 'UHD'])
       return false unless max_stored_resolution_validator.valid?(@max_stored_resolution)
       master_access_validator = EnumAttributeValidator.new('String', ['temporary', 'none'])
@@ -266,12 +289,22 @@ module MuxRuby
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['preparing', 'ready', '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] max_stored_resolution Object to be assigned
     def max_stored_resolution=(max_stored_resolution)
       validator = EnumAttributeValidator.new('String', ['Audio only', 'SD', 'HD', 'FHD', 'UHD'])
       unless validator.valid?(max_stored_resolution)
-        fail ArgumentError, 'invalid value for "max_stored_resolution", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"max_stored_resolution\", must be one of #{validator.allowable_values}."
       end
       @max_stored_resolution = max_stored_resolution
     end
@@ -281,7 +314,7 @@ module MuxRuby
     def master_access=(master_access)
       validator = EnumAttributeValidator.new('String', ['temporary', 'none'])
       unless validator.valid?(master_access)
-        fail ArgumentError, 'invalid value for "master_access", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"master_access\", must be one of #{validator.allowable_values}."
       end
       @master_access = master_access
     end
@@ -291,7 +324,7 @@ module MuxRuby
     def mp4_support=(mp4_support)
       validator = EnumAttributeValidator.new('String', ['standard', 'none'])
       unless validator.valid?(mp4_support)
-        fail ArgumentError, 'invalid value for "mp4_support", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"mp4_support\", must be one of #{validator.allowable_values}."
       end
       @mp4_support = mp4_support
     end
@@ -319,6 +352,7 @@ module MuxRuby
           master == o.master &&
           master_access == o.master_access &&
           mp4_support == o.mp4_support &&
+          source_asset_id == o.source_asset_id &&
           normalize_audio == o.normalize_audio &&
           static_renditions == o.static_renditions &&
           recording_times == o.recording_times &&
@@ -335,7 +369,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, created_at, deleted_at, status, duration, max_stored_resolution, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, is_live, passthrough, live_stream_id, master, master_access, mp4_support, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
+      [id, created_at, deleted_at, status, duration, max_stored_resolution, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/asset_errors.rb

@@ -7,8 +7,10 @@ require 'date'
 
 module MuxRuby
   class AssetErrors
+    # The type of error that occurred for this asset.
     attr_accessor :type
 
+    # Error messages with more details.
     attr_accessor :messages
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mux_ruby/models/asset_master.rb

@@ -6,11 +6,34 @@
 require 'date'
 
 module MuxRuby
+  # An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_acess` is set to `none` and when the temporary URL expires.
   class AssetMaster
     attr_accessor :status
 
     attr_accessor :url
 
+    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
       {
@@ -54,9 +77,21 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      status_validator = EnumAttributeValidator.new('String', ['ready', 'preparing', 'errored'])
+      return false unless status_validator.valid?(@status)
       true
     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', 'errored'])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb

@@ -7,31 +7,31 @@ require 'date'
 
 module MuxRuby
   class AssetNonStandardInputReasons
-    # The video codec used on the input file
+    # The video codec used on the input file.
     attr_accessor :video_codec
 
-    # The audio codec used on the input file
+    # The audio codec used on the input file.
     attr_accessor :audio_codec
 
-    # The video key frame Interval (also called as Group of Picture or GOP) of the input file
+    # The video key frame Interval (also called as Group of Picture or GOP) of the input file.
     attr_accessor :video_gop_size
 
-    # The video frame rate of the input file
+    # The video frame rate of the input file.
     attr_accessor :video_frame_rate
 
-    # The video resolution of the input file
+    # The video resolution of the input file.
     attr_accessor :video_resolution
 
-    # The video pixel aspect ratio of the input file
+    # The video pixel aspect ratio of the input file.
     attr_accessor :pixel_aspect_ratio
 
-    # Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List
+    # Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List.
     attr_accessor :video_edit_list
 
-    # Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List
+    # Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List.
     attr_accessor :audio_edit_list
 
-    # A catch-all reason when the input file in created with non-standard encoding parameters
+    # A catch-all reason when the input file in created with non-standard encoding parameters.
     attr_accessor :unexpected_media_file_parameters
 
     class EnumAttributeValidator
@@ -157,7 +157,7 @@ module MuxRuby
     def video_gop_size=(video_gop_size)
       validator = EnumAttributeValidator.new('String', ['high'])
       unless validator.valid?(video_gop_size)
-        fail ArgumentError, 'invalid value for "video_gop_size", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"video_gop_size\", must be one of #{validator.allowable_values}."
       end
       @video_gop_size = video_gop_size
     end
@@ -167,7 +167,7 @@ module MuxRuby
     def video_edit_list=(video_edit_list)
       validator = EnumAttributeValidator.new('String', ['non-standard'])
       unless validator.valid?(video_edit_list)
-        fail ArgumentError, 'invalid value for "video_edit_list", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"video_edit_list\", must be one of #{validator.allowable_values}."
       end
       @video_edit_list = video_edit_list
     end
@@ -177,7 +177,7 @@ module MuxRuby
     def audio_edit_list=(audio_edit_list)
       validator = EnumAttributeValidator.new('String', ['non-standard'])
       unless validator.valid?(audio_edit_list)
-        fail ArgumentError, 'invalid value for "audio_edit_list", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"audio_edit_list\", must be one of #{validator.allowable_values}."
       end
       @audio_edit_list = audio_edit_list
     end
@@ -187,7 +187,7 @@ module MuxRuby
     def unexpected_media_file_parameters=(unexpected_media_file_parameters)
       validator = EnumAttributeValidator.new('String', ['non-standard'])
       unless validator.valid?(unexpected_media_file_parameters)
-        fail ArgumentError, 'invalid value for "unexpected_media_file_parameters", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"unexpected_media_file_parameters\", must be one of #{validator.allowable_values}."
       end
       @unexpected_media_file_parameters = unexpected_media_file_parameters
     end

data/lib/mux_ruby/models/asset_recording_times.rb

@@ -7,10 +7,10 @@ require 'date'
 
 module MuxRuby
   class AssetRecordingTimes
-    # The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format
+    # The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
     attr_accessor :started_at
 
-    # The duration of the live stream recorded. The time value is in seconds
+    # The duration of the live stream recorded. The time value is in seconds.
     attr_accessor :duration
 
     # Attribute mapping from ruby-style variable name to JSON key.