mux_ruby 1.7.0 → 1.8.1

data/lib/mux_ruby/api/real_time_api.rb

@@ -0,0 +1,311 @@
+=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 RealTimeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Real-Time Breakdown
+    # Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dimension Dimension the specified value belongs to
+    # @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @return [GetRealTimeBreakdownResponse]
+    def get_realtime_breakdown(realtime_metric_id, opts = {})
+      data, _status_code, _headers = get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
+      data
+    end
+
+    # Get Real-Time Breakdown
+    # Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dimension Dimension the specified value belongs to
+    # @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @return [Array<(GetRealTimeBreakdownResponse, Fixnum, Hash)>] GetRealTimeBreakdownResponse data, response status code and response headers
+    def get_realtime_breakdown_with_http_info(realtime_metric_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_breakdown ...'
+      end
+      # verify the required parameter 'realtime_metric_id' is set
+      if @api_client.config.client_side_validation && realtime_metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_breakdown"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
+        fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
+      end
+      if @api_client.config.client_side_validation && opts[:'dimension'] && !['asn', 'cdn', 'country', 'operating_system', 'player_name', 'region', 'stream_type', 'sub_property_id', 'video_series', 'video_title'].include?(opts[:'dimension'])
+        fail ArgumentError, 'invalid value for "dimension", must be one of asn, cdn, country, operating_system, player_name, region, stream_type, sub_property_id, video_series, video_title'
+      end
+      if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
+        fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
+      end
+      if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
+        fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
+      end
+      # resource path
+      local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
+      query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
+      query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
+      query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
+      query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
+
+      # 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 => 'GetRealTimeBreakdownResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Real-Time Histogram Timeseries
+    # Gets histogram timeseries information for a specific metric. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @return [GetRealTimeHistogramTimeseriesResponse]
+    def get_realtime_histogram_timeseries(realtime_metric_id, opts = {})
+      data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_metric_id, opts)
+      data
+    end
+
+    # Get Real-Time Histogram Timeseries
+    # Gets histogram timeseries information for a specific metric. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @return [Array<(GetRealTimeHistogramTimeseriesResponse, Fixnum, Hash)>] GetRealTimeHistogramTimeseriesResponse data, response status code and response headers
+    def get_realtime_histogram_timeseries_with_http_info(realtime_metric_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_histogram_timeseries ...'
+      end
+      # verify the required parameter 'realtime_metric_id' is set
+      if @api_client.config.client_side_validation && realtime_metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_histogram_timeseries"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
+        fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
+      end
+      # resource path
+      local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/histogram-timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
+
+      # 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 => 'GetRealTimeHistogramTimeseriesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_histogram_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Real-Time Timeseries
+    # Gets Time series information for a specific metric along with the number of concurrent viewers. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @return [GetRealTimeTimeseriesResponse]
+    def get_realtime_timeseries(realtime_metric_id, opts = {})
+      data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
+      data
+    end
+
+    # Get Real-Time Timeseries
+    # Gets Time series information for a specific metric along with the number of concurrent viewers. 
+    # @param realtime_metric_id ID of the Realtime Metric
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :filters Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+    # @return [Array<(GetRealTimeTimeseriesResponse, Fixnum, Hash)>] GetRealTimeTimeseriesResponse data, response status code and response headers
+    def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_timeseries ...'
+      end
+      # verify the required parameter 'realtime_metric_id' is set
+      if @api_client.config.client_side_validation && realtime_metric_id.nil?
+        fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_timeseries"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['current-average-bitrate', 'current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'video-startup-time'].include?(realtime_metric_id)
+        fail ArgumentError, "invalid value for 'realtime_metric_id', must be one of current-average-bitrate, current-concurrent-viewers, current-rebuffering-percentage, exits-before-video-start, playback-failure-percentage, video-startup-time"
+      end
+      # resource path
+      local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', realtime_metric_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
+
+      # 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 => 'GetRealTimeTimeseriesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RealTimeApi#get_realtime_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Real-Time Dimensions
+    # Lists availiable real-time dimensions 
+    # @param [Hash] opts the optional parameters
+    # @return [ListRealTimeDimensionsResponse]
+    def list_realtime_dimensions(opts = {})
+      data, _status_code, _headers = list_realtime_dimensions_with_http_info(opts)
+      data
+    end
+
+    # List Real-Time Dimensions
+    # Lists availiable real-time dimensions 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListRealTimeDimensionsResponse, Fixnum, Hash)>] ListRealTimeDimensionsResponse data, response status code and response headers
+    def list_realtime_dimensions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_dimensions ...'
+      end
+      # resource path
+      local_var_path = '/data/v1/realtime/dimensions'
+
+      # 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 => 'ListRealTimeDimensionsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RealTimeApi#list_realtime_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Real-Time Metrics
+    # Lists availiable real-time metrics. 
+    # @param [Hash] opts the optional parameters
+    # @return [ListRealTimeMetricsResponse]
+    def list_realtime_metrics(opts = {})
+      data, _status_code, _headers = list_realtime_metrics_with_http_info(opts)
+      data
+    end
+
+    # List Real-Time Metrics
+    # Lists availiable real-time metrics. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListRealTimeMetricsResponse, Fixnum, Hash)>] ListRealTimeMetricsResponse data, response status code and response headers
+    def list_realtime_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_metrics ...'
+      end
+      # resource path
+      local_var_path = '/data/v1/realtime/metrics'
+
+      # 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 => 'ListRealTimeMetricsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RealTimeApi#list_realtime_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end

data/lib/mux_ruby/models/asset.rb

@@ -257,6 +257,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?
+      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'])
       return false unless master_access_validator.valid?(@master_access)
       mp4_support_validator = EnumAttributeValidator.new('String', ['standard', 'none'])
@@ -264,6 +266,16 @@ module MuxRuby
       true
     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}.'
+      end
+      @max_stored_resolution = max_stored_resolution
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] master_access Object to be assigned
     def master_access=(master_access)

data/lib/mux_ruby/models/dimension_value.rb

@@ -0,0 +1,193 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'date'
+
+module MuxRuby
+  class DimensionValue
+    attr_accessor :value
+
+    attr_accessor :total_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'value' => :'value',
+        :'total_count' => :'total_count'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'value' => :'String',
+        :'total_count' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.has_key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      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
+      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 &&
+          value == o.value &&
+          total_count == o.total_count
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [value, total_count].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 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        MuxRuby.const_get(type).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)
+        next if value.nil?
+        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