mux_ruby 1.0.0 → 1.3.0

data/lib/mux_ruby/models/simulcast_target_response.rb

@@ -0,0 +1,184 @@
+=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 SimulcastTargetResponse
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'SimulcastTarget'
+      }
+    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?(:'data')
+        self.data = attributes[:'data']
+      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 &&
+          data == o.data
+    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
+      [data].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

data/lib/mux_ruby/models/track.rb

@@ -23,9 +23,37 @@ module MuxRuby
 
     attr_accessor :max_channel_layout
 
-    attr_accessor :text_track_type
+    attr_accessor :text_type
 
-    attr_accessor :language
+    attr_accessor :language_code
+
+    attr_accessor :name
+
+    attr_accessor :closed_captions
+
+    attr_accessor :passthrough
+
+    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
@@ -38,8 +66,11 @@ module MuxRuby
         :'max_frame_rate' => :'max_frame_rate',
         :'max_channels' => :'max_channels',
         :'max_channel_layout' => :'max_channel_layout',
-        :'text_track_type' => :'text_track_type',
-        :'language' => :'language'
+        :'text_type' => :'text_type',
+        :'language_code' => :'language_code',
+        :'name' => :'name',
+        :'closed_captions' => :'closed_captions',
+        :'passthrough' => :'passthrough'
       }
     end
 
@@ -54,8 +85,11 @@ module MuxRuby
         :'max_frame_rate' => :'Float',
         :'max_channels' => :'Integer',
         :'max_channel_layout' => :'String',
-        :'text_track_type' => :'String',
-        :'language' => :'String'
+        :'text_type' => :'String',
+        :'language_code' => :'String',
+        :'name' => :'String',
+        :'closed_captions' => :'BOOLEAN',
+        :'passthrough' => :'String'
       }
     end
 
@@ -99,12 +133,24 @@ module MuxRuby
         self.max_channel_layout = attributes[:'max_channel_layout']
       end
 
-      if attributes.has_key?(:'text_track_type')
-        self.text_track_type = attributes[:'text_track_type']
+      if attributes.has_key?(:'text_type')
+        self.text_type = attributes[:'text_type']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.has_key?(:'language_code')
+        self.language_code = attributes[:'language_code']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'closed_captions')
+        self.closed_captions = attributes[:'closed_captions']
+      end
+
+      if attributes.has_key?(:'passthrough')
+        self.passthrough = attributes[:'passthrough']
       end
     end
 
@@ -118,9 +164,33 @@ module MuxRuby
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      type_validator = EnumAttributeValidator.new('String', ['video', 'audio', 'text'])
+      return false unless type_validator.valid?(@type)
+      text_type_validator = EnumAttributeValidator.new('String', ['subtitles'])
+      return false unless text_type_validator.valid?(@text_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    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}.'
+      end
+      @type = type
+    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}.'
+      end
+      @text_type = text_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -134,8 +204,11 @@ module MuxRuby
           max_frame_rate == o.max_frame_rate &&
           max_channels == o.max_channels &&
           max_channel_layout == o.max_channel_layout &&
-          text_track_type == o.text_track_type &&
-          language == o.language
+          text_type == o.text_type &&
+          language_code == o.language_code &&
+          name == o.name &&
+          closed_captions == o.closed_captions &&
+          passthrough == o.passthrough
     end
 
     # @see the `==` method
@@ -147,7 +220,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, type, duration, max_width, max_height, max_frame_rate, max_channels, max_channel_layout, text_track_type, language].hash
+      [id, type, duration, max_width, max_height, max_frame_rate, max_channels, max_channel_layout, text_type, language_code, name, closed_captions, passthrough].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/video_view_response.rb

@@ -23,7 +23,7 @@ module MuxRuby
     def self.openapi_types
       {
         :'data' => :'VideoView',
-        :'timeframe' => :'Array<String>'
+        :'timeframe' => :'Array<Integer>'
       }
     end
 

data/lib/mux_ruby/version.rb

@@ -4,5 +4,5 @@
 =end
 
 module MuxRuby
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

data/lib/mux_ruby.rb

@@ -22,7 +22,11 @@ require 'mux_ruby/models/create_asset_request'
 require 'mux_ruby/models/create_live_stream_request'
 require 'mux_ruby/models/create_playback_id_request'
 require 'mux_ruby/models/create_playback_id_response'
+require 'mux_ruby/models/create_simulcast_target_request'
+require 'mux_ruby/models/create_track_request'
+require 'mux_ruby/models/create_track_response'
 require 'mux_ruby/models/create_upload_request'
+require 'mux_ruby/models/delivery_report'
 require 'mux_ruby/models/error'
 require 'mux_ruby/models/filter_value'
 require 'mux_ruby/models/get_asset_input_info_response'
@@ -38,6 +42,7 @@ require 'mux_ruby/models/insight'
 require 'mux_ruby/models/list_all_metric_values_response'
 require 'mux_ruby/models/list_assets_response'
 require 'mux_ruby/models/list_breakdown_values_response'
+require 'mux_ruby/models/list_delivery_usage_response'
 require 'mux_ruby/models/list_errors_response'
 require 'mux_ruby/models/list_exports_response'
 require 'mux_ruby/models/list_filter_values_response'
@@ -58,6 +63,8 @@ require 'mux_ruby/models/score'
 require 'mux_ruby/models/signal_live_stream_complete_response'
 require 'mux_ruby/models/signing_key'
 require 'mux_ruby/models/signing_key_response'
+require 'mux_ruby/models/simulcast_target'
+require 'mux_ruby/models/simulcast_target_response'
 require 'mux_ruby/models/track'
 require 'mux_ruby/models/update_asset_mp4_support_request'
 require 'mux_ruby/models/upload'
@@ -69,6 +76,7 @@ require 'mux_ruby/models/video_view_response'
 
 # APIs
 require 'mux_ruby/api/assets_api'
+require 'mux_ruby/api/delivery_usage_api'
 require 'mux_ruby/api/direct_uploads_api'
 require 'mux_ruby/api/errors_api'
 require 'mux_ruby/api/exports_api'

data/spec/api/assets_api_spec.rb

@@ -49,6 +49,18 @@ describe 'AssetsApi' do
     end
   end
 
+  # unit tests for create_asset_track
+  # Create an asset track
+  # @param asset_id The asset ID.
+  # @param create_track_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateTrackResponse]
+  describe 'create_asset_track 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 delete_asset
   # Delete an asset
   # @param asset_id The asset ID.
@@ -72,6 +84,18 @@ describe 'AssetsApi' do
     end
   end
 
+  # unit tests for delete_asset_track
+  # Delete an asset track
+  # @param asset_id The asset ID.
+  # @param track_id The track ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_asset_track 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 get_asset
   # Retrieve an asset
   # Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.

data/spec/api/delivery_usage_api_spec.rb

@@ -0,0 +1,43 @@
+=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::DeliveryUsageApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DeliveryUsageApi' do
+  before do
+    # run before each test
+    @instance = MuxRuby::DeliveryUsageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DeliveryUsageApi' do
+    it 'should create an instance of DeliveryUsageApi' do
+      expect(@instance).to be_instance_of(MuxRuby::DeliveryUsageApi)
+    end
+  end
+
+  # unit tests for list_delivery_usage
+  # List Usage
+  # Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Offset by this many pages, of the size of `limit`
+  # @option opts [Integer] :limit Number of items to include in the response
+  # @option opts [String] :asset_id Filter response to return delivery usage for this asset only.
+  # @option opts [Array<String>] :timeframe Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. 
+  # @return [ListDeliveryUsageResponse]
+  describe 'list_delivery_usage 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/live_streams_api_spec.rb

@@ -48,6 +48,19 @@ describe 'LiveStreamsApi' do
     end
   end
 
+  # unit tests for create_live_stream_simulcast_target
+  # Create a live stream simulcast target
+  # Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
+  # @param live_stream_id The live stream ID
+  # @param create_simulcast_target_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SimulcastTargetResponse]
+  describe 'create_live_stream_simulcast_target 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 delete_live_stream
   # Delete a live stream
   # @param live_stream_id The live stream ID
@@ -71,6 +84,19 @@ describe 'LiveStreamsApi' do
     end
   end
 
+  # unit tests for delete_live_stream_simulcast_target
+  # Delete a Live Stream Simulcast Target
+  # Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
+  # @param live_stream_id The live stream ID
+  # @param simulcast_target_id The ID of the simulcast target.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_live_stream_simulcast_target 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 get_live_stream
   # Retrieve a live stream
   # Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
@@ -83,6 +109,19 @@ describe 'LiveStreamsApi' do
     end
   end
 
+  # unit tests for get_live_stream_simulcast_target
+  # Retrieve a Live Stream Simulcast Target
+  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
+  # @param live_stream_id The live stream ID
+  # @param simulcast_target_id The ID of the simulcast target.
+  # @param [Hash] opts the optional parameters
+  # @return [SimulcastTargetResponse]
+  describe 'get_live_stream_simulcast_target 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_live_streams
   # List live streams
   # @param [Hash] opts the optional parameters

data/spec/models/asset_spec.rb

@@ -147,6 +147,12 @@ describe 'Asset' do
     end
   end
 
+  describe 'test attribute "normalize_audio"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "static_renditions"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/create_asset_request_spec.rb

@@ -65,4 +65,20 @@ describe 'CreateAssetRequest' do
     end
   end
 
+  describe 'test attribute "normalize_audio"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "master_access"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["none", "temporary"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.master_access = value }.not_to raise_error
+      # end
+    end
+  end
+
 end

data/spec/models/create_live_stream_request_spec.rb

@@ -37,4 +37,22 @@ describe 'CreateLiveStreamRequest' do
     end
   end
 
+  describe 'test attribute "reconnect_window"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "passthrough"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "reduced_latency"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/create_simulcast_target_request_spec.rb

@@ -0,0 +1,46 @@
+=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'
+require 'date'
+
+# Unit tests for MuxRuby::CreateSimulcastTargetRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CreateSimulcastTargetRequest' do
+  before do
+    # run before each test
+    @instance = MuxRuby::CreateSimulcastTargetRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateSimulcastTargetRequest' do
+    it 'should create an instance of CreateSimulcastTargetRequest' do
+      expect(@instance).to be_instance_of(MuxRuby::CreateSimulcastTargetRequest)
+    end
+  end
+  describe 'test attribute "passthrough"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "stream_key"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end