mux_ruby 1.5.0 → 1.9.0

data/docs/NotificationRule.md

@@ -0,0 +1,10 @@
+# MuxRuby::NotificationRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/PlaybackID.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
+**id** | **String** | Unique identifier for the PlaybackID | [optional] 
 **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) |  | [optional] 
 
 

data/docs/PlaybackIDApi.md

@@ -0,0 +1,60 @@
+# MuxRuby::PlaybackIDApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an Asset or Live Stream ID
+
+
+# **get_asset_or_livestream_id**
+> GetAssetOrLiveStreamIdResponse get_asset_or_livestream_id(playback_id)
+
+Retrieve an Asset or Live Stream ID
+
+Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID. 
+
+### 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::PlaybackIDApi.new
+playback_id = 'playback_id_example' # String | The live stream's playback ID.
+
+begin
+  #Retrieve an Asset or Live Stream ID
+  result = api_instance.get_asset_or_livestream_id(playback_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling PlaybackIDApi->get_asset_or_livestream_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **playback_id** | **String**| The live stream's playback ID. | 
+
+### Return type
+
+[**GetAssetOrLiveStreamIdResponse**](GetAssetOrLiveStreamIdResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/RealTimeApi.md

@@ -0,0 +1,280 @@
+# MuxRuby::RealTimeApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_realtime_breakdown**](RealTimeApi.md#get_realtime_breakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown
+[**get_realtime_histogram_timeseries**](RealTimeApi.md#get_realtime_histogram_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries
+[**get_realtime_timeseries**](RealTimeApi.md#get_realtime_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries
+[**list_realtime_dimensions**](RealTimeApi.md#list_realtime_dimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions
+[**list_realtime_metrics**](RealTimeApi.md#list_realtime_metrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics
+
+
+# **get_realtime_breakdown**
+> GetRealTimeBreakdownResponse get_realtime_breakdown(realtime_metric_id, opts)
+
+Get Real-Time Breakdown
+
+Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. 
+
+### 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::RealTimeApi.new
+realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
+opts = {
+  dimension: 'dimension_example', # String | Dimension the specified value belongs to
+  timestamp: 3.4, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+  filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+  order_by: 'order_by_example', # String | Value to order the results by
+  order_direction: 'order_direction_example' # String | Sort order.
+}
+
+begin
+  #Get Real-Time Breakdown
+  result = api_instance.get_realtime_breakdown(realtime_metric_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling RealTimeApi->get_realtime_breakdown: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **realtime_metric_id** | **String**| ID of the Realtime Metric | 
+ **dimension** | **String**| Dimension the specified value belongs to | [optional] 
+ **timestamp** | **Float**| Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] 
+ **filters** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+ **order_by** | **String**| Value to order the results by | [optional] 
+ **order_direction** | **String**| Sort order. | [optional] 
+
+### Return type
+
+[**GetRealTimeBreakdownResponse**](GetRealTimeBreakdownResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_realtime_histogram_timeseries**
+> GetRealTimeHistogramTimeseriesResponse get_realtime_histogram_timeseries(realtime_metric_id, opts)
+
+Get Real-Time Histogram Timeseries
+
+Gets histogram timeseries information for a specific metric. 
+
+### 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::RealTimeApi.new
+realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
+opts = {
+  filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+}
+
+begin
+  #Get Real-Time Histogram Timeseries
+  result = api_instance.get_realtime_histogram_timeseries(realtime_metric_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **realtime_metric_id** | **String**| ID of the Realtime Metric | 
+ **filters** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+
+### Return type
+
+[**GetRealTimeHistogramTimeseriesResponse**](GetRealTimeHistogramTimeseriesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_realtime_timeseries**
+> GetRealTimeTimeseriesResponse get_realtime_timeseries(realtime_metric_id, opts)
+
+Get Real-Time Timeseries
+
+Gets Time series information for a specific metric along with the number of concurrent viewers. 
+
+### 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::RealTimeApi.new
+realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
+opts = {
+  filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+}
+
+begin
+  #Get Real-Time Timeseries
+  result = api_instance.get_realtime_timeseries(realtime_metric_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling RealTimeApi->get_realtime_timeseries: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **realtime_metric_id** | **String**| ID of the Realtime Metric | 
+ **filters** | [**Array&lt;String&gt;**](String.md)| 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.  | [optional] 
+
+### Return type
+
+[**GetRealTimeTimeseriesResponse**](GetRealTimeTimeseriesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_realtime_dimensions**
+> ListRealTimeDimensionsResponse list_realtime_dimensions
+
+List Real-Time Dimensions
+
+Lists availiable real-time dimensions 
+
+### 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::RealTimeApi.new
+
+begin
+  #List Real-Time Dimensions
+  result = api_instance.list_realtime_dimensions
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling RealTimeApi->list_realtime_dimensions: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListRealTimeDimensionsResponse**](ListRealTimeDimensionsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_realtime_metrics**
+> ListRealTimeMetricsResponse list_realtime_metrics
+
+List Real-Time Metrics
+
+Lists availiable real-time metrics. 
+
+### 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::RealTimeApi.new
+
+begin
+  #List Real-Time Metrics
+  result = api_instance.list_realtime_metrics
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling RealTimeApi->list_realtime_metrics: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListRealTimeMetricsResponse**](ListRealTimeMetricsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/RealTimeBreakdownValue.md

@@ -0,0 +1,12 @@
+# MuxRuby::RealTimeBreakdownValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**negative_impact** | **Integer** |  | [optional] 
+**metric_value** | **Float** |  | [optional] 
+**display_value** | **String** |  | [optional] 
+**concurent_viewers** | **Integer** |  | [optional] 
+
+

data/docs/RealTimeHistogramTimeseriesBucket.md

@@ -0,0 +1,9 @@
+# MuxRuby::RealTimeHistogramTimeseriesBucket
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **Integer** |  | [optional] 
+**_end** | **Integer** |  | [optional] 
+
+

data/docs/RealTimeHistogramTimeseriesBucketValues.md

@@ -0,0 +1,9 @@
+# MuxRuby::RealTimeHistogramTimeseriesBucketValues
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**percentage** | **Float** |  | [optional] 
+**count** | **Integer** |  | [optional] 
+
+

data/docs/RealTimeHistogramTimeseriesDatapoint.md

@@ -0,0 +1,14 @@
+# MuxRuby::RealTimeHistogramTimeseriesDatapoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **String** |  | [optional] 
+**sum** | **Integer** |  | [optional] 
+**p95** | **Float** |  | [optional] 
+**median** | **Float** |  | [optional] 
+**max_percentage** | **Float** |  | [optional] 
+**bucket_values** | [**Array<RealTimeHistogramTimeseriesBucketValues>**](RealTimeHistogramTimeseriesBucketValues.md) |  | [optional] 
+**average** | **Float** |  | [optional] 
+
+

data/docs/RealTimeTimeseriesDatapoint.md

@@ -0,0 +1,10 @@
+# MuxRuby::RealTimeTimeseriesDatapoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | [optional] 
+**date** | **String** |  | [optional] 
+**concurent_viewers** | **Integer** |  | [optional] 
+
+

data/docs/Track.md

@@ -3,18 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**type** | **String** |  | [optional] 
-**duration** | **Float** |  | [optional] 
-**max_width** | **Integer** |  | [optional] 
-**max_height** | **Integer** |  | [optional] 
-**max_frame_rate** | **Float** |  | [optional] 
-**max_channels** | **Integer** |  | [optional] 
-**max_channel_layout** | **String** |  | [optional] 
-**text_type** | **String** |  | [optional] 
-**language_code** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**closed_captions** | **BOOLEAN** |  | [optional] 
-**passthrough** | **String** |  | [optional] 
+**id** | **String** | Unique identifier for the Track | [optional] 
+**type** | **String** | The type of track | [optional] 
+**duration** | **Float** | 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. | [optional] 
+**max_width** | **Integer** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional] 
+**max_height** | **Integer** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional] 
+**max_frame_rate** | **Float** | 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. | [optional] 
+**max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] 
+**max_channel_layout** | **String** | Only set for the `audio` type track. | [optional] 
+**text_type** | **String** | This parameter is set only for the `text` type track. | [optional] 
+**language_code** | **String** | 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. | [optional] 
+**name** | **String** | 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. | [optional] 
+**closed_captions** | **BOOLEAN** | 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. | [optional] 
+**passthrough** | **String** | 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. | [optional]