mux_ruby 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b0deedd1384c8570bba28d6fbb40647a70f92f4
-  data.tar.gz: bba59bbf79426e17ba5e1eb30a53f227db79499e
+  metadata.gz: a82c3ff3d2f7a0856d87eeb12181161e46fd94b0
+  data.tar.gz: b0bc8878a363818ebf49889ccf57739a1b7d4bc1
 SHA512:
-  metadata.gz: 84c62cb5252f550f8b2e9542cb68eaa42c51c1ee1a3ad88f237f480ac63e664ba1345b663b5923e6e9dfc2beffabc07cb5b1535a16fbdbb67f06a9c652132f91
-  data.tar.gz: b0f0434546abde5a60e2970416670c40d12a5a10f3c128a28f57afcd76253ba2234dbc3aadda646ac55ddafa8c0ba86119cf6235f81d6b4a3df65d51e81dff88
+  metadata.gz: 4eb34200000fdb35dc50892d46ead7e99046cdacdd1639a88e209d398abf2b22302345a7fefc3e8524c0e09718ab48fbad3cfd84380e5ed67df1bfde85d1ade4
+  data.tar.gz: 481d66f9f17b8ba653ed30d2bb2b6ed2c8aa194563820e99c39063554afaa00621d9b0555f2ffe63d214a6dfecf09417831e564264e8995800fc6e82d5d5921a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.3.1)
+    mux_ruby (1.4.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/docs/AssetsApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
 [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
 [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets
+[**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
 [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
 
 
@@ -524,6 +525,59 @@ Name | Type | Description  | Notes
 
 
 
+# **update_asset_master_access**
+> AssetResponse update_asset_master_access(asset_id, update_asset_master_access_request)
+
+Update master access
+
+Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
+
+### Example
+```ruby
+# load the gem
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AssetsApi.new
+asset_id = 'asset_id_example' # String | The asset ID.
+update_asset_master_access_request = MuxRuby::UpdateAssetMasterAccessRequest.new # UpdateAssetMasterAccessRequest | 
+
+begin
+  #Update master access
+  result = api_instance.update_asset_master_access(asset_id, update_asset_master_access_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling AssetsApi->update_asset_master_access: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The asset ID. | 
+ **update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md)|  | 
+
+### Return type
+
+[**AssetResponse**](AssetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_asset_mp4_support**
 > AssetResponse update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
 

data/docs/UpdateAssetMasterAccessRequest.md

@@ -0,0 +1,8 @@
+# MuxRuby::UpdateAssetMasterAccessRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**master_access** | **String** | Add or remove access to the master version of the video. | [optional] 
+
+

data/examples/video/exercise-assets.rb

@@ -77,6 +77,16 @@ assert mp4_asset.data.id == create_response.data.id
 assert mp4_asset.data.mp4_support == 'standard'
 puts "update-asset-mp4-support OK ✅"
 
+# ========== update-asset-master-access ==========
+master_req = MuxRuby::UpdateAssetMasterAccessRequest.new
+master_req.master_access = 'temporary'
+master_asset = assets_api.update_asset_master_access(create_response.data.id, master_req)
+assert master_asset != nil
+assert master_asset.data != nil
+assert master_asset.data.id == create_response.data.id
+assert master_asset.data.master_access == 'temporary'
+puts "update-asset-master-access OK ✅"
+
 # ========== create-asset-track ==========
 cat = MuxRuby::CreateTrackRequest.new(:url => "https://tears-of-steel-subtitles.s3.amazonaws.com/tears-en.vtt", :type => "text", :text_type => "subtitles", :language_code => "en", :name => "English", :closed_captions => false)
 subtitles_track = assets_api.create_asset_track(create_response.data.id, cat)

data/lib/mux_ruby/api/assets_api.rb

@@ -555,6 +555,67 @@ module MuxRuby
       return data, status_code, headers
     end
 
+    # Update master access
+    # Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
+    # @param asset_id The asset ID.
+    # @param update_asset_master_access_request 
+    # @param [Hash] opts the optional parameters
+    # @return [AssetResponse]
+    def update_asset_master_access(asset_id, update_asset_master_access_request, opts = {})
+      data, _status_code, _headers = update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request, opts)
+      data
+    end
+
+    # Update master access
+    # Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
+    # @param asset_id The asset ID.
+    # @param update_asset_master_access_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AssetResponse, Fixnum, Hash)>] AssetResponse data, response status code and response headers
+    def update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AssetsApi.update_asset_master_access ...'
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.update_asset_master_access"
+      end
+      # verify the required parameter 'update_asset_master_access_request' is set
+      if @api_client.config.client_side_validation && update_asset_master_access_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_asset_master_access_request' when calling AssetsApi.update_asset_master_access"
+      end
+      # resource path
+      local_var_path = '/video/v1/assets/{ASSET_ID}/master-access'.sub('{' + 'ASSET_ID' + '}', asset_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(update_asset_master_access_request)
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AssetResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AssetsApi#update_asset_master_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update MP4 support
     # Allows you add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
     # @param asset_id The asset ID.

data/lib/mux_ruby/models/update_asset_master_access_request.rb

@@ -0,0 +1,219 @@
+=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 UpdateAssetMasterAccessRequest
+    # Add or remove access to the master version of the video.
+    attr_accessor :master_access
+
+    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
+      {
+        :'master_access' => :'master_access'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'master_access' => :'String'
+      }
+    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?(:'master_access')
+        self.master_access = attributes[:'master_access']
+      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?
+      master_access_validator = EnumAttributeValidator.new('String', ['temporary', 'none'])
+      return false unless master_access_validator.valid?(@master_access)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] master_access Object to be assigned
+    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}.'
+      end
+      @master_access = master_access
+    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 &&
+          master_access == o.master_access
+    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
+      [master_access].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/version.rb

@@ -4,5 +4,5 @@
 =end
 
 module MuxRuby
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/mux_ruby.rb

@@ -67,6 +67,7 @@ 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/update_asset_master_access_request'
 require 'mux_ruby/models/upload'
 require 'mux_ruby/models/upload_error'
 require 'mux_ruby/models/upload_response'

data/spec/api/assets_api_spec.rb

@@ -144,6 +144,19 @@ describe 'AssetsApi' do
     end
   end
 
+  # unit tests for update_asset_master_access
+  # Update master access
+  # Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
+  # @param asset_id The asset ID.
+  # @param update_asset_master_access_request 
+  # @param [Hash] opts the optional parameters
+  # @return [AssetResponse]
+  describe 'update_asset_master_access 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 update_asset_mp4_support
   # Update MP4 support
   # Allows you add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.

data/spec/models/update_asset_master_access_request_spec.rb

@@ -0,0 +1,38 @@
+=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::UpdateAssetMasterAccessRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UpdateAssetMasterAccessRequest' do
+  before do
+    # run before each test
+    @instance = MuxRuby::UpdateAssetMasterAccessRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UpdateAssetMasterAccessRequest' do
+    it 'should create an instance of UpdateAssetMasterAccessRequest' do
+      expect(@instance).to be_instance_of(MuxRuby::UpdateAssetMasterAccessRequest)
+    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', ["temporary", "none"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.master_access = value }.not_to raise_error
+      # end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mux_ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Mux SDK Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -268,6 +268,7 @@ files:
 - docs/Track.md
 - docs/URLSigningKeysApi.md
 - docs/UpdateAssetMP4SupportRequest.md
+- docs/UpdateAssetMasterAccessRequest.md
 - docs/Upload.md
 - docs/UploadError.md
 - docs/UploadResponse.md
@@ -359,6 +360,7 @@ files:
 - lib/mux_ruby/models/simulcast_target.rb
 - lib/mux_ruby/models/simulcast_target_response.rb
 - lib/mux_ruby/models/track.rb
+- lib/mux_ruby/models/update_asset_master_access_request.rb
 - lib/mux_ruby/models/update_asset_mp4_support_request.rb
 - lib/mux_ruby/models/upload.rb
 - lib/mux_ruby/models/upload_error.rb
@@ -436,6 +438,7 @@ files:
 - spec/models/simulcast_target_response_spec.rb
 - spec/models/simulcast_target_spec.rb
 - spec/models/track_spec.rb
+- spec/models/update_asset_master_access_request_spec.rb
 - spec/models/update_asset_mp4_support_request_spec.rb
 - spec/models/upload_error_spec.rb
 - spec/models/upload_response_spec.rb
@@ -510,6 +513,7 @@ test_files:
 - spec/models/breakdown_value_spec.rb
 - spec/models/list_live_streams_response_spec.rb
 - spec/models/list_all_metric_values_response_spec.rb
+- spec/models/update_asset_master_access_request_spec.rb
 - spec/models/input_file_spec.rb
 - spec/models/abridged_video_view_spec.rb
 - spec/models/overall_values_spec.rb