mux_ruby 1.6.0 → 2.0.0.pre.rc.2

data/docs/GetAssetInputInfoResponse.md

@@ -1,8 +1,18 @@
 # MuxRuby::GetAssetInputInfoResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<InputInfo>**](InputInfo.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<InputInfo>**](InputInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetAssetInputInfoResponse.new(
+  data: null
+)
+```
 

data/docs/GetAssetOrLiveStreamIdResponse.md

@@ -0,0 +1,18 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetAssetOrLiveStreamIdResponse.new(
+  data: null
+)
+```
+

data/docs/GetAssetOrLiveStreamIdResponseData.md

@@ -0,0 +1,22 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional] |
+| **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) |  | [optional] |
+| **object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetAssetOrLiveStreamIdResponseData.new(
+  id: null,
+  policy: null,
+  object: null
+)
+```
+

data/docs/GetAssetOrLiveStreamIdResponseDataObject.md

@@ -0,0 +1,20 @@
+# MuxRuby::GetAssetOrLiveStreamIdResponseDataObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The identifier of the object. | [optional] |
+| **type** | **String** | Identifies the object type associated with the playback ID. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetAssetOrLiveStreamIdResponseDataObject.new(
+  id: null,
+  type: null
+)
+```
+

data/docs/GetAssetPlaybackIDResponse.md

@@ -1,8 +1,18 @@
 # MuxRuby::GetAssetPlaybackIDResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PlaybackID**](.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**PlaybackID**](.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetAssetPlaybackIDResponse.new(
+  data: null
+)
+```
 

data/docs/GetMetricTimeseriesDataResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::GetMetricTimeseriesDataResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **Array<Array<String>>** |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Array<Array<String>>** |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetMetricTimeseriesDataResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/GetOverallValuesResponse.md

@@ -1,10 +1,22 @@
 # MuxRuby::GetOverallValuesResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**OverallValues**](OverallValues.md) |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**OverallValues**](OverallValues.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetOverallValuesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
 

data/docs/GetRealTimeBreakdownResponse.md

@@ -0,0 +1,22 @@
+# MuxRuby::GetRealTimeBreakdownResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetRealTimeBreakdownResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
+

data/docs/GetRealTimeHistogramTimeseriesResponse.md

@@ -0,0 +1,24 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) |  | [optional] |
+| **data** | [**Array<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetRealTimeHistogramTimeseriesResponse.new(
+  meta: null,
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
+

data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md

@@ -0,0 +1,18 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta.new(
+  buckets: null
+)
+```
+

data/docs/GetRealTimeTimeseriesResponse.md

@@ -0,0 +1,22 @@
+# MuxRuby::GetRealTimeTimeseriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GetRealTimeTimeseriesResponse.new(
+  data: null,
+  total_row_count: null,
+  timeframe: null
+)
+```
+

data/docs/Incident.md

@@ -0,0 +1,58 @@
+# MuxRuby::Incident
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **threshold** | **Float** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **started_at** | **String** |  | [optional] |
+| **severity** | **String** |  | [optional] |
+| **sample_size_unit** | **String** |  | [optional] |
+| **sample_size** | **Integer** |  | [optional] |
+| **resolved_at** | **String** |  | [optional] |
+| **notifications** | [**Array<IncidentNotification>**](IncidentNotification.md) |  | [optional] |
+| **notification_rules** | [**Array<IncidentNotificationRule>**](IncidentNotificationRule.md) |  | [optional] |
+| **measurement** | **String** |  | [optional] |
+| **measured_value_on_close** | **Float** |  | [optional] |
+| **measured_value** | **Float** |  | [optional] |
+| **incident_key** | **String** |  | [optional] |
+| **impact** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **error_description** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **breakdowns** | [**Array<IncidentBreakdown>**](IncidentBreakdown.md) |  | [optional] |
+| **affected_views_per_hour_on_open** | **Integer** |  | [optional] |
+| **affected_views_per_hour** | **Integer** |  | [optional] |
+| **affected_views** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Incident.new(
+  threshold: null,
+  status: null,
+  started_at: null,
+  severity: null,
+  sample_size_unit: null,
+  sample_size: null,
+  resolved_at: null,
+  notifications: null,
+  notification_rules: null,
+  measurement: null,
+  measured_value_on_close: null,
+  measured_value: null,
+  incident_key: null,
+  impact: null,
+  id: null,
+  error_description: null,
+  description: null,
+  breakdowns: null,
+  affected_views_per_hour_on_open: null,
+  affected_views_per_hour: null,
+  affected_views: null
+)
+```
+

data/docs/IncidentBreakdown.md

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

data/docs/IncidentNotification.md

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

data/docs/IncidentNotificationRule.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::IncidentNotificationRule.new(
+  status: null,
+  rules: null,
+  property_id: null,
+  id: null,
+  action: null
+)
+```
+

data/docs/IncidentResponse.md

@@ -0,0 +1,20 @@
+# MuxRuby::IncidentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Incident**](.md) |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::IncidentResponse.new(
+  data: null,
+  timeframe: null
+)
+```
+

data/docs/IncidentsApi.md

@@ -0,0 +1,242 @@
+# 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.
+
+### 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::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 "Error when calling IncidentsApi->get_incident: #{e}"
+end
+```
+
+#### Using the get_incident_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IncidentResponse>, Integer, Hash)> get_incident_with_http_info(incident_id)
+
+```ruby
+begin
+  # Get an Incident
+  data, status_code, headers = api_instance.get_incident_with_http_info(incident_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IncidentResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->get_incident_with_http_info: #{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.
+
+### 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::IncidentsApi.new
+opts = {
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  order_by: 'negative_impact', # String | Value to order the results by
+  order_direction: 'asc', # String | Sort order.
+  status: 'open', # String | Status to filter incidents by
+  severity: 'warning' # String | Severity to filter incidents by
+}
+
+begin
+  # List Incidents
+  result = api_instance.list_incidents(opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_incidents: #{e}"
+end
+```
+
+#### Using the list_incidents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListIncidentsResponse>, Integer, Hash)> list_incidents_with_http_info(opts)
+
+```ruby
+begin
+  # List Incidents
+  data, status_code, headers = api_instance.list_incidents_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListIncidentsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_incidents_with_http_info: #{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 &#x60;limit&#x60; | [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.
+
+### 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::IncidentsApi.new
+incident_id = 'abcd1234' # String | ID of the Incident
+opts = {
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
+  order_by: 'negative_impact', # String | Value to order the results by
+  order_direction: 'asc' # String | Sort order.
+}
+
+begin
+  # List Related Incidents
+  result = api_instance.list_related_incidents(incident_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_related_incidents: #{e}"
+end
+```
+
+#### Using the list_related_incidents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRelatedIncidentsResponse>, Integer, Hash)> list_related_incidents_with_http_info(incident_id, opts)
+
+```ruby
+begin
+  # List Related Incidents
+  data, status_code, headers = api_instance.list_related_incidents_with_http_info(incident_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRelatedIncidentsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling IncidentsApi->list_related_incidents_with_http_info: #{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 &#x60;limit&#x60; | [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
+