mux_ruby 1.5.0 → 1.9.0

data/lib/mux_ruby/models/track.rb

@@ -7,30 +7,43 @@ require 'date'
 
 module MuxRuby
   class Track
+    # Unique identifier for the Track
     attr_accessor :id
 
+    # The type of track
     attr_accessor :type
 
+    # The duration in seconds of the track media. This parameter is not set for the `text` type track. This field is optional and may not be set. The top level `duration` field of an asset will always be set.
     attr_accessor :duration
 
+    # The maximum width in pixels available for the track. Only set for the `video` type track.
     attr_accessor :max_width
 
+    # The maximum height in pixels available for the track. Only set for the `video` type track.
     attr_accessor :max_height
 
+    # The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined.
     attr_accessor :max_frame_rate
 
+    # The maximum number of audio channels the track supports. Only set for the `audio` type track.
     attr_accessor :max_channels
 
+    # Only set for the `audio` type track.
     attr_accessor :max_channel_layout
 
+    # This parameter is set only for the `text` type track.
     attr_accessor :text_type
 
+    # The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is set for `text` type and `subtitles` text type track.
     attr_accessor :language_code
 
+    # The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is set for the `text` type and `subtitles` text type track.
     attr_accessor :name
 
+    # Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the `text` type and `subtitles` text type track.
     attr_accessor :closed_captions
 
+    # Arbitrary metadata set for the track either when creating the asset or track. This parameter is set for `text` type and `subtitles` text type track. Max 255 characters.
     attr_accessor :passthrough
 
     class EnumAttributeValidator
@@ -166,6 +179,8 @@ module MuxRuby
     def valid?
       type_validator = EnumAttributeValidator.new('String', ['video', 'audio', 'text'])
       return false unless type_validator.valid?(@type)
+      max_channel_layout_validator = EnumAttributeValidator.new('String', ['mono', 'stereo', '5.2', '7.1'])
+      return false unless max_channel_layout_validator.valid?(@max_channel_layout)
       text_type_validator = EnumAttributeValidator.new('String', ['subtitles'])
       return false unless text_type_validator.valid?(@text_type)
       true
@@ -176,17 +191,27 @@ module MuxRuby
     def type=(type)
       validator = EnumAttributeValidator.new('String', ['video', 'audio', 'text'])
       unless validator.valid?(type)
-        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
+        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] max_channel_layout Object to be assigned
+    def max_channel_layout=(max_channel_layout)
+      validator = EnumAttributeValidator.new('String', ['mono', 'stereo', '5.2', '7.1'])
+      unless validator.valid?(max_channel_layout)
+        fail ArgumentError, "invalid value for \"max_channel_layout\", must be one of #{validator.allowable_values}."
+      end
+      @max_channel_layout = max_channel_layout
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] text_type Object to be assigned
     def text_type=(text_type)
       validator = EnumAttributeValidator.new('String', ['subtitles'])
       unless validator.valid?(text_type)
-        fail ArgumentError, 'invalid value for "text_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"text_type\", must be one of #{validator.allowable_values}."
       end
       @text_type = text_type
     end

data/lib/mux_ruby/models/update_asset_master_access_request.rb

@@ -79,7 +79,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

data/lib/mux_ruby/models/update_asset_mp4_support_request.rb

@@ -79,7 +79,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

data/lib/mux_ruby/models/upload.rb

@@ -172,7 +172,7 @@ module MuxRuby
     def status=(status)
       validator = EnumAttributeValidator.new('String', ['waiting', 'asset_created', 'errored', 'cancelled', 'timed_out'])
       unless validator.valid?(status)
-        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
       @status = status
     end

data/lib/mux_ruby/models/video_view.rb

@@ -223,10 +223,14 @@ module MuxRuby
 
     attr_accessor :asn
 
+    attr_accessor :asn_name
+
     attr_accessor :quality_score
 
     attr_accessor :player_software_version
 
+    attr_accessor :player_mux_plugin_name
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -338,8 +342,10 @@ module MuxRuby
         :'player_autoplay' => :'player_autoplay',
         :'player_height' => :'player_height',
         :'asn' => :'asn',
+        :'asn_name' => :'asn_name',
         :'quality_score' => :'quality_score',
-        :'player_software_version' => :'player_software_version'
+        :'player_software_version' => :'player_software_version',
+        :'player_mux_plugin_name' => :'player_mux_plugin_name'
       }
     end
 
@@ -354,22 +360,22 @@ module MuxRuby
         :'preroll_requested' => :'BOOLEAN',
         :'page_type' => :'String',
         :'startup_score' => :'String',
-        :'view_seek_duration' => :'String',
+        :'view_seek_duration' => :'Integer',
         :'country_name' => :'String',
         :'player_source_height' => :'Integer',
         :'longitude' => :'String',
-        :'buffering_count' => :'String',
-        :'video_duration' => :'String',
+        :'buffering_count' => :'Integer',
+        :'video_duration' => :'Integer',
         :'player_source_type' => :'String',
         :'city' => :'String',
         :'view_id' => :'String',
         :'platform_description' => :'String',
-        :'video_startup_preroll_request_time' => :'String',
+        :'video_startup_preroll_request_time' => :'Integer',
         :'viewer_device_name' => :'String',
         :'video_series' => :'String',
         :'viewer_application_name' => :'String',
         :'updated_at' => :'String',
-        :'view_total_content_playback_time' => :'String',
+        :'view_total_content_playback_time' => :'Integer',
         :'cdn' => :'String',
         :'player_instance_id' => :'String',
         :'video_language' => :'String',
@@ -380,8 +386,8 @@ module MuxRuby
         :'playback_score' => :'String',
         :'page_url' => :'String',
         :'metro' => :'String',
-        :'view_max_request_latency' => :'String',
-        :'requests_for_first_preroll' => :'String',
+        :'view_max_request_latency' => :'Integer',
+        :'requests_for_first_preroll' => :'Integer',
         :'view_total_downscaling' => :'String',
         :'latitude' => :'String',
         :'player_source_host_name' => :'String',
@@ -391,7 +397,7 @@ module MuxRuby
         :'player_language' => :'String',
         :'page_load_time' => :'Integer',
         :'viewer_device_category' => :'String',
-        :'video_startup_preroll_load_time' => :'String',
+        :'video_startup_preroll_load_time' => :'Integer',
         :'player_version' => :'String',
         :'watch_time' => :'Integer',
         :'player_source_stream_type' => :'String',
@@ -401,14 +407,14 @@ module MuxRuby
         :'experiment_name' => :'String',
         :'viewer_os_version' => :'String',
         :'player_preload' => :'BOOLEAN',
-        :'buffering_duration' => :'String',
+        :'buffering_duration' => :'Integer',
         :'player_view_count' => :'Integer',
         :'player_software' => :'String',
-        :'player_load_time' => :'String',
+        :'player_load_time' => :'Integer',
         :'platform_summary' => :'String',
         :'video_encoding_variant' => :'String',
         :'player_width' => :'Integer',
-        :'view_seek_count' => :'String',
+        :'view_seek_count' => :'Integer',
         :'viewer_experience_score' => :'String',
         :'view_error_id' => :'Integer',
         :'video_variant_name' => :'String',
@@ -420,7 +426,7 @@ module MuxRuby
         :'events' => :'Array<VideoViewEvent>',
         :'player_name' => :'String',
         :'view_start' => :'String',
-        :'view_average_request_throughput' => :'String',
+        :'view_average_request_throughput' => :'Integer',
         :'video_producer' => :'String',
         :'error_type_id' => :'Integer',
         :'mux_viewer_id' => :'String',
@@ -431,7 +437,7 @@ module MuxRuby
         :'video_content_type' => :'String',
         :'viewer_os_family' => :'String',
         :'player_poster' => :'String',
-        :'view_average_request_latency' => :'String',
+        :'view_average_request_latency' => :'Integer',
         :'video_variant_id' => :'String',
         :'player_source_duration' => :'Integer',
         :'player_source_url' => :'String',
@@ -440,7 +446,7 @@ module MuxRuby
         :'id' => :'String',
         :'short_time' => :'String',
         :'rebuffer_percentage' => :'String',
-        :'time_to_first_frame' => :'String',
+        :'time_to_first_frame' => :'Integer',
         :'viewer_user_id' => :'String',
         :'video_stream_type' => :'String',
         :'player_startup_time' => :'Integer',
@@ -454,8 +460,10 @@ module MuxRuby
         :'player_autoplay' => :'BOOLEAN',
         :'player_height' => :'Integer',
         :'asn' => :'Integer',
+        :'asn_name' => :'String',
         :'quality_score' => :'String',
-        :'player_software_version' => :'String'
+        :'player_software_version' => :'String',
+        :'player_mux_plugin_name' => :'String'
       }
     end
 
@@ -901,6 +909,10 @@ module MuxRuby
         self.asn = attributes[:'asn']
       end
 
+      if attributes.has_key?(:'asn_name')
+        self.asn_name = attributes[:'asn_name']
+      end
+
       if attributes.has_key?(:'quality_score')
         self.quality_score = attributes[:'quality_score']
       end
@@ -908,6 +920,10 @@ module MuxRuby
       if attributes.has_key?(:'player_software_version')
         self.player_software_version = attributes[:'player_software_version']
       end
+
+      if attributes.has_key?(:'player_mux_plugin_name')
+        self.player_mux_plugin_name = attributes[:'player_mux_plugin_name']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1036,8 +1052,10 @@ module MuxRuby
           player_autoplay == o.player_autoplay &&
           player_height == o.player_height &&
           asn == o.asn &&
+          asn_name == o.asn_name &&
           quality_score == o.quality_score &&
-          player_software_version == o.player_software_version
+          player_software_version == o.player_software_version &&
+          player_mux_plugin_name == o.player_mux_plugin_name
     end
 
     # @see the `==` method
@@ -1049,7 +1067,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [view_total_upscaling, preroll_ad_asset_hostname, player_source_domain, region, viewer_user_agent, preroll_requested, page_type, startup_score, view_seek_duration, country_name, player_source_height, longitude, buffering_count, video_duration, player_source_type, city, view_id, platform_description, video_startup_preroll_request_time, viewer_device_name, video_series, viewer_application_name, updated_at, view_total_content_playback_time, cdn, player_instance_id, video_language, player_source_width, player_error_message, player_mux_plugin_version, watched, playback_score, page_url, metro, view_max_request_latency, requests_for_first_preroll, view_total_downscaling, latitude, player_source_host_name, inserted_at, view_end, mux_embed_version, player_language, page_load_time, viewer_device_category, video_startup_preroll_load_time, player_version, watch_time, player_source_stream_type, preroll_ad_tag_hostname, viewer_device_manufacturer, rebuffering_score, experiment_name, viewer_os_version, player_preload, buffering_duration, player_view_count, player_software, player_load_time, platform_summary, video_encoding_variant, player_width, view_seek_count, viewer_experience_score, view_error_id, video_variant_name, preroll_played, viewer_application_engine, viewer_os_architecture, player_error_code, buffering_rate, events, player_name, view_start, view_average_request_throughput, video_producer, error_type_id, mux_viewer_id, video_id, continent_code, session_id, exit_before_video_start, video_content_type, viewer_os_family, player_poster, view_average_request_latency, video_variant_id, player_source_duration, player_source_url, mux_api_version, video_title, id, short_time, rebuffer_percentage, time_to_first_frame, viewer_user_id, video_stream_type, player_startup_time, viewer_application_version, view_max_downscale_percentage, view_max_upscale_percentage, country_code, used_fullscreen, isp, property_id, player_autoplay, player_height, asn, quality_score, player_software_version].hash
+      [view_total_upscaling, preroll_ad_asset_hostname, player_source_domain, region, viewer_user_agent, preroll_requested, page_type, startup_score, view_seek_duration, country_name, player_source_height, longitude, buffering_count, video_duration, player_source_type, city, view_id, platform_description, video_startup_preroll_request_time, viewer_device_name, video_series, viewer_application_name, updated_at, view_total_content_playback_time, cdn, player_instance_id, video_language, player_source_width, player_error_message, player_mux_plugin_version, watched, playback_score, page_url, metro, view_max_request_latency, requests_for_first_preroll, view_total_downscaling, latitude, player_source_host_name, inserted_at, view_end, mux_embed_version, player_language, page_load_time, viewer_device_category, video_startup_preroll_load_time, player_version, watch_time, player_source_stream_type, preroll_ad_tag_hostname, viewer_device_manufacturer, rebuffering_score, experiment_name, viewer_os_version, player_preload, buffering_duration, player_view_count, player_software, player_load_time, platform_summary, video_encoding_variant, player_width, view_seek_count, viewer_experience_score, view_error_id, video_variant_name, preroll_played, viewer_application_engine, viewer_os_architecture, player_error_code, buffering_rate, events, player_name, view_start, view_average_request_throughput, video_producer, error_type_id, mux_viewer_id, video_id, continent_code, session_id, exit_before_video_start, video_content_type, viewer_os_family, player_poster, view_average_request_latency, video_variant_id, player_source_duration, player_source_url, mux_api_version, video_title, id, short_time, rebuffer_percentage, time_to_first_frame, viewer_user_id, video_stream_type, player_startup_time, viewer_application_version, view_max_downscale_percentage, view_max_upscale_percentage, country_code, used_fullscreen, isp, property_id, player_autoplay, player_height, asn, asn_name, quality_score, player_software_version, player_mux_plugin_name].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/version.rb

@@ -4,5 +4,5 @@
 =end
 
 module MuxRuby
-  VERSION = '1.5.0'
+  VERSION = '1.9.0'
 end

data/mux_ruby.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 
+  s.metadata    = { "source_code_uri" => "https://github.com/muxinc/mux-ruby" }
+
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 

data/spec/api/assets_api_spec.rb

@@ -63,6 +63,7 @@ describe 'AssetsApi' do
 
   # unit tests for delete_asset
   # 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]
@@ -134,6 +135,7 @@ describe 'AssetsApi' do
 
   # unit tests for list_assets
   # 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 `limit`

data/spec/api/dimensions_api_spec.rb

@@ -0,0 +1,55 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MuxRuby::DimensionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DimensionsApi' do
+  before do
+    # run before each test
+    @instance = MuxRuby::DimensionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DimensionsApi' do
+    it 'should create an instance of DimensionsApi' do
+      expect(@instance).to be_instance_of(MuxRuby::DimensionsApi)
+    end
+  end
+
+  # unit tests for list_dimension_values
+  # Lists the values for a specific dimension
+  # Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+  # @param dimension_id ID of the Dimension
+  # @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 `limit`
+  # @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 [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600    * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. 
+  # @return [ListDimensionValuesResponse]
+  describe 'list_dimension_values test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_dimensions
+  # List Dimensions
+  # List all available dimensions.  Note: This API replaces the list-filters API call. 
+  # @param [Hash] opts the optional parameters
+  # @return [ListDimensionsResponse]
+  describe 'list_dimensions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/filters_api_spec.rb

@@ -27,7 +27,7 @@ describe 'FiltersApi' do
 
   # unit tests for list_filter_values
   # Lists values for a specific filter
-  # Lists the values for a filter along with a total count of related views 
+  # Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
   # @param filter_id ID of the Filter
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :limit Number of items to include in the response
@@ -43,7 +43,7 @@ describe 'FiltersApi' do
 
   # unit tests for list_filters
   # List Filters
-  # Lists all the filters broken out into basic and advanced 
+  # Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
   # @param [Hash] opts the optional parameters
   # @return [ListFiltersResponse]
   describe 'list_filters test' do

data/spec/api/incidents_api_spec.rb

@@ -0,0 +1,73 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MuxRuby::IncidentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'IncidentsApi' do
+  before do
+    # run before each test
+    @instance = MuxRuby::IncidentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IncidentsApi' do
+    it 'should create an instance of IncidentsApi' do
+      expect(@instance).to be_instance_of(MuxRuby::IncidentsApi)
+    end
+  end
+
+  # unit tests for get_incident
+  # Get an Incident
+  # Returns the details of an incident 
+  # @param incident_id ID of the Incident
+  # @param [Hash] opts the optional parameters
+  # @return [IncidentResponse]
+  describe 'get_incident test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_incidents
+  # List Incidents
+  # Returns a list of incidents 
+  # @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 `limit`
+  # @option opts [String] :order_by Value to order the results by
+  # @option opts [String] :order_direction Sort order.
+  # @option opts [String] :status Status to filter incidents by
+  # @option opts [String] :severity Severity to filter incidents by
+  # @return [ListIncidentsResponse]
+  describe 'list_incidents test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_related_incidents
+  # List Related Incidents
+  # Returns all the incidents that seem related to a specific incident 
+  # @param incident_id ID of the Incident
+  # @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 `limit`
+  # @option opts [String] :order_by Value to order the results by
+  # @option opts [String] :order_direction Sort order.
+  # @return [ListRelatedIncidentsResponse]
+  describe 'list_related_incidents test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end