mux_ruby 1.0.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 071d7be8b7ea6111c37e3252ddfde75ac1fb5023
-  data.tar.gz: 875bdcd5f51c8691cf37f8bfa614b05ad4712be6
+SHA256:
+  metadata.gz: 664515a5f746766972c6c3e9f59a2c841543ca0ab7978d6eab39ecd23880b74d
+  data.tar.gz: 04052222b86990956e14ce2a43843f8397bddea70c2e043fa2863586e9023fec
 SHA512:
-  metadata.gz: 81204bff2d0b39af4df872ecbc45e3024bcc7ba48c74a8be90269e0ab51400336948c6bb80740ab2463ec52acdf448d9d008fde70fa95f3ef9665320328947c2
-  data.tar.gz: '00895ba9e6abcd30d6825efeea7b2b58785a8a5fd5714d6cfcf394eb99559964de51176e4218786d1aa893a550413b5da4c1e7b3a7f4aded3216cb32036f5c65'
+  metadata.gz: f465821843ac6207dffd085a0db7fec3b306e26fa6ed0b4beb9692896411fafae7f2f6784c70b37107da5978c938d51be59b8a1625f160c7afd0af71bd9bf9ee
+  data.tar.gz: 42fc66417a9e0b2988064fd8b4729303b0dff0c9db5c56b97e71ea5fafa3c2ff100d3f3f5c035dcac19f1be14f5ae22f3c16fbbbca003887064e1efc212275a9

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
   gem 'pry-byebug'
+  gem 'solid_assert'
 end

data/Gemfile.lock

@@ -1,58 +1,59 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.0.0)
+    mux_ruby (1.5.1)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.11.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    ZenTest (4.12.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.14)
+    autotest-fsevent (0.2.17)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    byebug (10.0.2)
+    byebug (11.1.1)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.9.25)
-    hashdiff (0.3.7)
-    json (2.1.0)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    public_suffix (3.0.3)
-    rake (12.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    json (2.3.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.4)
-    sys-uname (1.0.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    solid_assert (1.0.0)
+    sys-uname (1.2.1)
       ffi (>= 1.0.0)
-    typhoeus (1.3.0)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
     vcr (3.0.3)
     webmock (1.24.6)
@@ -70,10 +71,11 @@ DEPENDENCIES
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   mux_ruby!
   pry-byebug
-  rake (~> 12.0.0)
+  rake (~> 12.3.3)
   rspec (~> 3.6, >= 3.6.0)
+  solid_assert
   vcr (~> 3.0, >= 3.0.1)
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -1,5 +1,7 @@
 ![Mux Ruby Banner](github-ruby-sdk.png)
 
+![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
+
 # Mux Ruby
 
 Official Mux API wrapper for ruby projects, supporting both Mux Data and Mux Video.
@@ -112,10 +114,13 @@ All errors inherit from `ApiError`, you can catch it or you can catch one of the
 [Be sure to check out the documentation in the `docs` directory.](docs/)
 
 ## Issues
+
 If you run into problems, [please raise a GitHub issue,](https://github.com/muxinc/mux-ruby/issues) filling in the issue template. We'll take a look as soon as possible.
 
 ## Contributing
+
 Please do not submit PRs against this package. It is generated from our OpenAPI definitions - [Please open an issue instead!](https://github.com/muxinc/mux-ruby/issues)
 
 ## License
+
 [MIT License.](LICENSE) Copyright 2019 Mux, Inc.

data/docs/Asset.md

@@ -13,7 +13,6 @@ Name | Type | Description | Notes
 **aspect_ratio** | **String** |  | [optional] 
 **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
 **tracks** | [**Array<Track>**](Track.md) |  | [optional] 
-**demo** | **BOOLEAN** |  | [optional] 
 **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
 **is_live** | **BOOLEAN** |  | [optional] 
@@ -22,6 +21,8 @@ Name | Type | Description | Notes
 **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] 
 **master_access** | **String** |  | [optional] [default to 'none']
 **mp4_support** | **String** |  | [optional] [default to 'none']
+**normalize_audio** | **BOOLEAN** |  | [optional] [default to false]
 **static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/AssetsApi.md

@@ -6,12 +6,15 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset
 [**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
+[**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
 [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
 [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
+[**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
 [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
 [**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
 
 
@@ -117,6 +120,57 @@ Name | Type | Description  | Notes
 
 
 
+# **create_asset_track**
+> CreateTrackResponse create_asset_track(asset_id, create_track_request)
+
+Create an asset track
+
+### 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.
+create_track_request = MuxRuby::CreateTrackRequest.new # CreateTrackRequest | 
+
+begin
+  #Create an asset track
+  result = api_instance.create_asset_track(asset_id, create_track_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling AssetsApi->create_asset_track: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The asset ID. | 
+ **create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md)|  | 
+
+### Return type
+
+[**CreateTrackResponse**](CreateTrackResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_asset**
 > delete_asset(asset_id)
 
@@ -215,6 +269,56 @@ nil (empty response body)
 
 
 
+# **delete_asset_track**
+> delete_asset_track(asset_id, track_id)
+
+Delete an asset track
+
+### 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.
+track_id = 'track_id_example' # String | The track ID.
+
+begin
+  #Delete an asset track
+  api_instance.delete_asset_track(asset_id, track_id)
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling AssetsApi->delete_asset_track: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The asset ID. | 
+ **track_id** | **String**| The track ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
 # **get_asset**
 > AssetResponse get_asset(asset_id)
 
@@ -421,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/CreateAssetRequest.md

@@ -5,9 +5,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input** | [**Array<InputSettings>**](InputSettings.md) |  | [optional] 
 **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] 
-**demo** | **BOOLEAN** |  | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
 **passthrough** | **String** |  | [optional] 
 **mp4_support** | **String** |  | [optional] 
+**normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
+**master_access** | **String** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/CreateLiveStreamRequest.md

@@ -5,5 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] 
 **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] 
+**reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] 
+**passthrough** | **String** |  | [optional] 
+**reduced_latency** | **BOOLEAN** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/CreateSimulcastTargetRequest.md

@@ -0,0 +1,10 @@
+# MuxRuby::CreateSimulcastTargetRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional] 
+**stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] 
+**url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. | 
+
+

data/docs/CreateTrackRequest.md

@@ -0,0 +1,14 @@
+# MuxRuby::CreateTrackRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | 
+**type** | **String** |  | 
+**text_type** | **String** |  | 
+**language_code** | **String** |  | 
+**name** | **String** |  | [optional] 
+**closed_captions** | **BOOLEAN** |  | [optional] 
+**passthrough** | **String** |  | [optional] 
+
+

data/docs/CreateTrackResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::CreateTrackResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Track**](.md) |  | [optional] 
+
+

data/docs/CreateUploadRequest.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600]
 **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] 
 **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/DeliveryReport.md

@@ -0,0 +1,14 @@
+# MuxRuby::DeliveryReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live_stream_id** | **String** |  | [optional] 
+**asset_id** | **String** |  | [optional] 
+**passthrough** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**asset_state** | **String** |  | [optional] 
+**asset_duration** | **Float** |  | [optional] 
+**delivered_seconds** | **Float** |  | [optional] 
+
+

data/docs/DeliveryUsageApi.md

@@ -0,0 +1,68 @@
+# MuxRuby::DeliveryUsageApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_delivery_usage**](DeliveryUsageApi.md#list_delivery_usage) | **GET** /video/v1/delivery-usage | List Usage
+
+
+# **list_delivery_usage**
+> ListDeliveryUsageResponse list_delivery_usage(opts)
+
+List Usage
+
+Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs. 
+
+### 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::DeliveryUsageApi.new
+opts = {
+  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  limit: 100, # Integer | Number of items to include in the response
+  asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
+  timeframe: ['timeframe_example'] # Array<String> | 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. 
+}
+
+begin
+  #List Usage
+  result = api_instance.list_delivery_usage(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DeliveryUsageApi->list_delivery_usage: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
+ **limit** | **Integer**| Number of items to include in the response | [optional] [default to 100]
+ **asset_id** | **String**| Filter response to return delivery usage for this asset only. | [optional] 
+ **timeframe** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+
+### Return type
+
+[**ListDeliveryUsageResponse**](ListDeliveryUsageResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+