mux_ruby 1.0.0 → 1.5.1

data/docs/GetMetricTimeseriesDataResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | **Array<Array<String>>** |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/GetOverallValuesResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**OverallValues**](OverallValues.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/InputSettings.md

@@ -4,7 +4,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** |  | [optional] 
-**language** | **String** |  | [optional] 
 **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] 
+**type** | **String** |  | [optional] 
+**text_type** | **String** |  | [optional] 
+**language_code** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**closed_captions** | **BOOLEAN** |  | [optional] 
+**passthrough** | **String** |  | [optional] 
 
 

data/docs/InputTrack.md

@@ -12,7 +12,5 @@ Name | Type | Description | Notes
 **sample_rate** | **Integer** |  | [optional] 
 **sample_size** | **Integer** |  | [optional] 
 **channels** | **Integer** |  | [optional] 
-**text_track_type** | **String** |  | [optional] 
-**language** | **String** |  | [optional] 
 
 

data/docs/Insight.md

@@ -5,8 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **total_watch_time** | **Integer** |  | [optional] 
 **total_views** | **Integer** |  | [optional] 
-**negative_impact_score** | **Integer** |  | [optional] 
-**metric** | **Integer** |  | [optional] 
+**negative_impact_score** | **Float** |  | [optional] 
+**metric** | **Float** |  | [optional] 
 **filter_value** | **String** |  | [optional] 
 **filter_column** | **String** |  | [optional] 
 

data/docs/ListAllMetricValuesResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<Score>**](Score.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListBreakdownValuesResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<BreakdownValue>**](BreakdownValue.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListDeliveryUsageResponse.md

@@ -0,0 +1,11 @@
+# MuxRuby::ListDeliveryUsageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DeliveryReport>**](DeliveryReport.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+**limit** | **Integer** | Number of assets returned in this response. Default value is 100. | [optional] 
+
+

data/docs/ListErrorsResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<Error>**](Error.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListExportsResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | **Array<String>** |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListFilterValuesResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<FilterValue>**](FilterValue.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListFiltersResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListInsightsResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<Insight>**](Insight.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/ListVideoViewsResponse.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**Array<AbridgedVideoView>**](AbridgedVideoView.md) |  | [optional] 
 **total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/docs/LiveStream.md

@@ -13,5 +13,8 @@ Name | Type | Description | Notes
 **new_asset_settings** | [**Asset**](Asset.md) |  | [optional] 
 **passthrough** | **String** |  | [optional] 
 **reconnect_window** | **Float** |  | [optional] 
+**reduced_latency** | **BOOLEAN** |  | [optional] 
+**simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/LiveStreamsApi.md

@@ -6,9 +6,12 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_live_stream**](LiveStreamsApi.md#create_live_stream) | **POST** /video/v1/live-streams | Create a live stream
 [**create_live_stream_playback_id**](LiveStreamsApi.md#create_live_stream_playback_id) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids | Create a live stream playback ID
+[**create_live_stream_simulcast_target**](LiveStreamsApi.md#create_live_stream_simulcast_target) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets | Create a live stream simulcast target
 [**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
 [**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
+[**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
 [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
+[**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
 [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
 [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key
 [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished
@@ -114,6 +117,59 @@ Name | Type | Description  | Notes
 
 
 
+# **create_live_stream_simulcast_target**
+> SimulcastTargetResponse create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
+
+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.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+create_simulcast_target_request = MuxRuby::CreateSimulcastTargetRequest.new # CreateSimulcastTargetRequest | 
+
+begin
+  #Create a live stream simulcast target
+  result = api_instance.create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->create_live_stream_simulcast_target: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+ **create_simulcast_target_request** | [**CreateSimulcastTargetRequest**](CreateSimulcastTargetRequest.md)|  | 
+
+### Return type
+
+[**SimulcastTargetResponse**](SimulcastTargetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_live_stream**
 > delete_live_stream(live_stream_id)
 
@@ -212,6 +268,58 @@ nil (empty response body)
 
 
 
+# **delete_live_stream_simulcast_target**
+> delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
+
+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.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
+
+begin
+  #Delete a Live Stream Simulcast Target
+  api_instance.delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->delete_live_stream_simulcast_target: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+ **simulcast_target_id** | **String**| The ID of the simulcast target. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
 # **get_live_stream**
 > LiveStreamResponse get_live_stream(live_stream_id)
 
@@ -263,6 +371,59 @@ Name | Type | Description  | Notes
 
 
 
+# **get_live_stream_simulcast_target**
+> SimulcastTargetResponse get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
+
+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.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+simulcast_target_id = 'simulcast_target_id_example' # String | The ID of the simulcast target.
+
+begin
+  #Retrieve a Live Stream Simulcast Target
+  result = api_instance.get_live_stream_simulcast_target(live_stream_id, simulcast_target_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->get_live_stream_simulcast_target: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+ **simulcast_target_id** | **String**| The ID of the simulcast target. | 
+
+### Return type
+
+[**SimulcastTargetResponse**](SimulcastTargetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **list_live_streams**
 > ListLiveStreamsResponse list_live_streams(opts)
 

data/docs/SigningKeyResponse.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**SigningKey**](SigningKey.md) |  | [optional] 
+**data** | [**SigningKey**](.md) |  | [optional] 
 
 

data/docs/SimulcastTarget.md

@@ -0,0 +1,12 @@
+# MuxRuby::SimulcastTarget
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the Simulcast Target | [optional] 
+**passthrough** | **String** | Arbitrary Metadata set when creating a simulcast target. | [optional] 
+**status** | **String** | The current status of the simulcast target. See Statuses below for detailed description.   * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.   * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state.   * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.   * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established.  | [optional] 
+**stream_key** | **String** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] 
+**url** | **String** | RTMP hostname including the application name for the third party live streaming service. | [optional] 
+
+

data/docs/SimulcastTargetResponse.md

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

data/docs/Track.md

@@ -11,7 +11,10 @@ Name | Type | Description | Notes
 **max_frame_rate** | **Float** |  | [optional] 
 **max_channels** | **Integer** |  | [optional] 
 **max_channel_layout** | **String** |  | [optional] 
-**text_track_type** | **String** |  | [optional] 
-**language** | **String** |  | [optional] 
+**text_type** | **String** |  | [optional] 
+**language_code** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**closed_captions** | **BOOLEAN** |  | [optional] 
+**passthrough** | **String** |  | [optional] 
 
 

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/docs/Upload.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **error** | [**UploadError**](UploadError.md) |  | [optional] 
 **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] 
 **url** | **String** | The URL to upload the associated source media to. | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/VideoViewResponse.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **data** | [**VideoView**](.md) |  | [optional] 
-**timeframe** | **Array<String>** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
 
 

data/examples/data/exercise-errors.rb

@@ -15,7 +15,7 @@ end
 errors_api = MuxRuby::ErrorsApi.new
 
 # ========== list-errors ==========
-errors = errors_api.list_errors(:filters => ['browser:Firefox'], :timeframe => ['7:days'])
+errors = errors_api.list_errors(:filters => ['browser:Safari'], :timeframe => ['7:days'])
 assert errors != nil
 assert errors.data != nil
 assert errors.data.length > 0

data/examples/data/exercise-metrics.rb

@@ -5,13 +5,6 @@ require 'solid_assert'
 
 SolidAssert.enable_assertions
 
-# Exercises all asset operations:
-#   list-breakdown-values
-#   get-overall-values
-#   list-insights
-#   get-metric-timeseries-data
-#   list-all-metric-values
-
 # Authentication Setup
 openapi = MuxRuby.configure do |config|
   config.username = ENV['MUX_TOKEN_ID']

data/examples/video/exercise-assets.rb

@@ -16,7 +16,7 @@ assets_api = MuxRuby::AssetsApi.new
 
 # ========== create-asset ==========
 car = MuxRuby::CreateAssetRequest.new
-car.input = 'https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4'
+car.input = [{:url => 'https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4'}, {:url => "https://tears-of-steel-subtitles.s3.amazonaws.com/tears-fr.vtt", :type => "text", :text_type => "subtitles", :name => "French", :language_code => "fr", :closed_captions => false}]
 create_response = assets_api.create_asset(car)
 assert create_response != nil
 assert create_response.data.id != nil
@@ -77,6 +77,32 @@ 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)
+assert subtitles_track != nil
+assert subtitles_track.data.id != nil
+assert subtitles_track.data.name == 'English'
+asset_with_2_captions = assets_api.get_asset(create_response.data.id)
+assert asset_with_2_captions.data.tracks.length == 4 # Audio, Video, French that we ingested with the asset, and the English we added here!
+puts "create-asset-track OK ✅"
+
+# ========== delete-asset-track ==========
+assets_api.delete_asset_track(create_response.data.id, subtitles_track.data.id)
+asset_with_1_captions = assets_api.get_asset(create_response.data.id)
+assert asset_with_1_captions.data.tracks.length == 3 # Audio, Video, French that we ingested with the asset
+puts "delete-asset-track OK ✅"
+
 # ========== delete-asset-playback-id ==========
 assets_api.delete_asset_playback_id(create_response.data.id, pb_id_c.data.id)
 deleted_playback_id_asset = assets_api.get_asset(create_response.data.id)