mux_ruby 1.5.1 → 2.0.0.pre.rc.1

data/docs/NotificationRule.md

@@ -0,0 +1,22 @@
+# MuxRuby::NotificationRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::NotificationRule.new(
+  value: null,
+  name: null,
+  id: null
+)
+```
+

data/docs/OverallValues.md

@@ -1,11 +1,24 @@
 # MuxRuby::OverallValues
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **Float** |  | [optional] 
-**total_watch_time** | **Integer** |  | [optional] 
-**total_views** | **Integer** |  | [optional] 
-**global_value** | **Float** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Float** |  | [optional] |
+| **total_watch_time** | **Integer** |  | [optional] |
+| **total_views** | **Integer** |  | [optional] |
+| **global_value** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::OverallValues.new(
+  value: null,
+  total_watch_time: null,
+  total_views: null,
+  global_value: null
+)
+```
 

data/docs/PlaybackID.md

@@ -1,9 +1,20 @@
 # MuxRuby::PlaybackID
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**policy** | [**PlaybackPolicy**](PlaybackPolicy.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the PlaybackID | [optional] |
+| **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::PlaybackID.new(
+  id: null,
+  policy: null
+)
+```
 

data/docs/PlaybackIDApi.md

@@ -0,0 +1,78 @@
+# 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. 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling PlaybackIDApi->get_asset_or_livestream_id: #{e}"
+end
+```
+
+#### Using the get_asset_or_livestream_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAssetOrLiveStreamIdResponse>, Integer, Hash)> get_asset_or_livestream_id_with_http_info(playback_id)
+
+```ruby
+begin
+  # Retrieve an Asset or Live Stream ID
+  data, status_code, headers = api_instance.get_asset_or_livestream_id_with_http_info(playback_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAssetOrLiveStreamIdResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling PlaybackIDApi->get_asset_or_livestream_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **playback_id** | **String** | The live stream&#39;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/PlaybackPolicy.md

@@ -1,7 +1,15 @@
 # MuxRuby::PlaybackPolicy
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::PlaybackPolicy.new()
+```
 

data/docs/RealTimeApi.md

@@ -0,0 +1,376 @@
+# 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_HISTOGRAM_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. 
+
+### Examples
+
+```ruby
+require 'time'
+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 = 'current-concurrent-viewers' # String | ID of the Realtime Metric
+opts = {
+  dimension: 'asn', # String | Dimension the specified value belongs to
+  timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
+  filters: ['inner_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: 'negative_impact', # String | Value to order the results by
+  order_direction: 'asc' # 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 "Error when calling RealTimeApi->get_realtime_breakdown: #{e}"
+end
+```
+
+#### Using the get_realtime_breakdown_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRealTimeBreakdownResponse>, Integer, Hash)> get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
+
+```ruby
+begin
+  # Get Real-Time Breakdown
+  data, status_code, headers = api_instance.get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRealTimeBreakdownResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->get_realtime_breakdown_with_http_info: #{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_histogram_metric_id, opts)
+
+Get Real-Time Histogram Timeseries
+
+Gets histogram timeseries information for a specific metric. 
+
+### Examples
+
+```ruby
+require 'time'
+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_histogram_metric_id = 'video-startup-time' # String | ID of the Realtime Histogram Metric
+opts = {
+  filters: ['inner_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_histogram_metric_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
+end
+```
+
+#### Using the get_realtime_histogram_timeseries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRealTimeHistogramTimeseriesResponse>, Integer, Hash)> get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
+
+```ruby
+begin
+  # Get Real-Time Histogram Timeseries
+  data, status_code, headers = api_instance.get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRealTimeHistogramTimeseriesResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **realtime_histogram_metric_id** | **String** | ID of the Realtime Histogram 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. 
+
+### Examples
+
+```ruby
+require 'time'
+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 = 'current-concurrent-viewers' # String | ID of the Realtime Metric
+opts = {
+  filters: ['inner_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 "Error when calling RealTimeApi->get_realtime_timeseries: #{e}"
+end
+```
+
+#### Using the get_realtime_timeseries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRealTimeTimeseriesResponse>, Integer, Hash)> get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
+
+```ruby
+begin
+  # Get Real-Time Timeseries
+  data, status_code, headers = api_instance.get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRealTimeTimeseriesResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->get_realtime_timeseries_with_http_info: #{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 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling RealTimeApi->list_realtime_dimensions: #{e}"
+end
+```
+
+#### Using the list_realtime_dimensions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRealTimeDimensionsResponse>, Integer, Hash)> list_realtime_dimensions_with_http_info
+
+```ruby
+begin
+  # List Real-Time Dimensions
+  data, status_code, headers = api_instance.list_realtime_dimensions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRealTimeDimensionsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->list_realtime_dimensions_with_http_info: #{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. 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling RealTimeApi->list_realtime_metrics: #{e}"
+end
+```
+
+#### Using the list_realtime_metrics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRealTimeMetricsResponse>, Integer, Hash)> list_realtime_metrics_with_http_info
+
+```ruby
+begin
+  # List Real-Time Metrics
+  data, status_code, headers = api_instance.list_realtime_metrics_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRealTimeMetricsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling RealTimeApi->list_realtime_metrics_with_http_info: #{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
+