mux_ruby 1.4.0 → 1.8.1

data/docs/IncidentBreakdown.md

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

data/docs/IncidentNotification.md

@@ -0,0 +1,10 @@
+# MuxRuby::IncidentNotification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**queued_at** | **String** |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**attempted_at** | **String** |  | [optional] 
+
+

data/docs/IncidentNotificationRule.md

@@ -0,0 +1,12 @@
+# MuxRuby::IncidentNotificationRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**rules** | [**Array<NotificationRule>**](NotificationRule.md) |  | [optional] 
+**property_id** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**action** | **String** |  | [optional] 
+
+

data/docs/IncidentResponse.md

@@ -0,0 +1,9 @@
+# MuxRuby::IncidentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Incident**](.md) |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/IncidentsApi.md

@@ -0,0 +1,186 @@
+# MuxRuby::IncidentsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_incident**](IncidentsApi.md#get_incident) | **GET** /data/v1/incidents/{INCIDENT_ID} | Get an Incident
+[**list_incidents**](IncidentsApi.md#list_incidents) | **GET** /data/v1/incidents | List Incidents
+[**list_related_incidents**](IncidentsApi.md#list_related_incidents) | **GET** /data/v1/incidents/{INCIDENT_ID}/related | List Related Incidents
+
+
+# **get_incident**
+> IncidentResponse get_incident(incident_id)
+
+Get an Incident
+
+Returns the details of an incident 
+
+### 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::IncidentsApi.new
+incident_id = 'abcd1234' # String | ID of the Incident
+
+begin
+  #Get an Incident
+  result = api_instance.get_incident(incident_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling IncidentsApi->get_incident: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **incident_id** | **String**| ID of the Incident | 
+
+### Return type
+
+[**IncidentResponse**](IncidentResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_incidents**
+> ListIncidentsResponse list_incidents(opts)
+
+List Incidents
+
+Returns a list of incidents 
+
+### 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::IncidentsApi.new
+opts = {
+  limit: 25, # Integer | Number of items to include in the response
+  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  order_by: 'order_by_example', # String | Value to order the results by
+  order_direction: 'order_direction_example', # String | Sort order.
+  status: 'status_example', # String | Status to filter incidents by
+  severity: 'severity_example' # String | Severity to filter incidents by
+}
+
+begin
+  #List Incidents
+  result = api_instance.list_incidents(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling IncidentsApi->list_incidents: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
+ **page** | **Integer**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
+ **order_by** | **String**| Value to order the results by | [optional] 
+ **order_direction** | **String**| Sort order. | [optional] 
+ **status** | **String**| Status to filter incidents by | [optional] 
+ **severity** | **String**| Severity to filter incidents by | [optional] 
+
+### Return type
+
+[**ListIncidentsResponse**](ListIncidentsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_related_incidents**
+> ListRelatedIncidentsResponse list_related_incidents(incident_id, opts)
+
+List Related Incidents
+
+Returns all the incidents that seem related to a specific incident 
+
+### 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::IncidentsApi.new
+incident_id = 'abcd1234' # String | ID of the Incident
+opts = {
+  limit: 25, # Integer | Number of items to include in the response
+  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  order_by: 'order_by_example', # String | Value to order the results by
+  order_direction: 'order_direction_example' # String | Sort order.
+}
+
+begin
+  #List Related Incidents
+  result = api_instance.list_related_incidents(incident_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling IncidentsApi->list_related_incidents: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **incident_id** | **String**| ID of the Incident | 
+ **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
+ **page** | **Integer**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
+ **order_by** | **String**| Value to order the results by | [optional] 
+ **order_direction** | **String**| Sort order. | [optional] 
+
+### Return type
+
+[**ListRelatedIncidentsResponse**](ListRelatedIncidentsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ListDimensionValuesResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListDimensionValuesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DimensionValue>**](DimensionValue.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ListDimensionsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListDimensionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ListFiltersResponseData**](ListFiltersResponseData.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ListIncidentsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListIncidentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<Incident>**](Incident.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ListRealTimeDimensionsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListRealTimeDimensionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ListRealTimeDimensionsResponseData>**](ListRealTimeDimensionsResponseData.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ListRealTimeDimensionsResponseData.md

@@ -0,0 +1,9 @@
+# MuxRuby::ListRealTimeDimensionsResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+
+

data/docs/ListRealTimeMetricsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListRealTimeMetricsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ListRealTimeDimensionsResponseData>**](ListRealTimeDimensionsResponseData.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/ListRelatedIncidentsResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::ListRelatedIncidentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<Incident>**](Incident.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/LiveStream.md

@@ -10,10 +10,11 @@ Name | Type | Description | Notes
 **recent_asset_ids** | **Array<String>** |  | [optional] 
 **status** | **String** |  | [optional] 
 **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
-**new_asset_settings** | [**Asset**](Asset.md) |  | [optional] 
+**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.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

@@ -10,6 +10,8 @@ Method | HTTP request | Description
 [**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
+[**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
+[**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
 [**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
@@ -320,6 +322,108 @@ nil (empty response body)
 
 
 
+# **disable_live_stream**
+> DisableLiveStreamResponse disable_live_stream(live_stream_id)
+
+Disable a live stream
+
+Disables a live stream, making it reject incoming RTMP streams until re-enabled.
+
+### 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
+
+begin
+  #Disable a live stream
+  result = api_instance.disable_live_stream(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->disable_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**DisableLiveStreamResponse**](DisableLiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **enable_live_stream**
+> EnableLiveStreamResponse enable_live_stream(live_stream_id)
+
+Enable a live stream
+
+Enables a live stream, allowing it to accept an incoming RTMP stream.
+
+### 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
+
+begin
+  #Enable a live stream
+  result = api_instance.enable_live_stream(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->enable_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**EnableLiveStreamResponse**](EnableLiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_live_stream**
 > LiveStreamResponse get_live_stream(live_stream_id)
 

data/docs/NotificationRule.md

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