mux_ruby 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbf90e37874b351e072e692180c58a354d436faddbb9f9d0f2c9a9d95868f4f
-  data.tar.gz: b8e1b2f842ec53b7447df8d4cb7ba51a4ec39ec83593edfcd83dc8e76289222e
+  metadata.gz: 949908e8ddb5270a36db4c9df9991f878e91b8e95ad6a1260506b956861f7ec6
+  data.tar.gz: 368bcacc1322c6308fce401c068e74a5ae0bd3627e1eb2261db5d30bd53e0fa7
 SHA512:
-  metadata.gz: 7d4b97bfbe38e4fcbab508520383eec2d36c79551cc176a1ae4b4d2bb397e2d3e05dbab8d58da94de21c409fb2f2d66e95b4f6d16121c8673e182ecd2014f538
-  data.tar.gz: 0e7ac75c0ce0d429ae02710b35a1bc7ef3a5182ef1f138c8f2b435ac1b2a3fe70e259ed10c224a44865d06101adb7c4fd34cc262f60095f6b9391e60a7e9f8a6
+  metadata.gz: fde803ebf5c4db63c13522a8d4513282d74e1305725f122e87232be2d3126fdd1ff95c931f1e535c8d9d5de227d31924d7163a53cc51791294fb41c9afed78aa
+  data.tar.gz: 279bdcfeb349d5f4176e0e4408597644053052ef7a3cd85152a6443e50f9c7e6704e8e2dc5d7341814cd37e96b8f9cd8bf3be6fefca36989462eddaa28152f1b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.7.0)
+    mux_ruby (1.8.1)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/docs/DimensionValue.md

@@ -0,0 +1,9 @@
+# MuxRuby::DimensionValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**total_count** | **Integer** |  | [optional] 
+
+

data/docs/DimensionsApi.md

@@ -0,0 +1,118 @@
+# MuxRuby::DimensionsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
+[**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions
+
+
+# **list_dimension_values**
+> ListDimensionValuesResponse list_dimension_values(dimension_id, opts)
+
+Lists the values for a specific dimension
+
+Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+
+### 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::DimensionsApi.new
+dimension_id = 'abcd1234' # String | ID of the Dimension
+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`
+  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. 
+  timeframe: ['timeframe_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600    * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. 
+}
+
+begin
+  #Lists the values for a specific dimension
+  result = api_instance.list_dimension_values(dimension_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimension_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dimension_id** | **String**| ID of the Dimension | 
+ **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]
+ **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] 
+ **timeframe** | [**Array&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600    * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.  | [optional] 
+
+### Return type
+
+[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_dimensions**
+> ListDimensionsResponse list_dimensions
+
+List Dimensions
+
+List all available dimensions.  Note: This API replaces the list-filters API call. 
+
+### 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::DimensionsApi.new
+
+begin
+  #List Dimensions
+  result = api_instance.list_dimensions
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimensions: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDimensionsResponse**](ListDimensionsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/FiltersApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Lists values for a specific filter
 
-Lists the values for a filter along with a total count of related views 
+Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
 
 ### Example
 ```ruby
@@ -74,7 +74,7 @@ Name | Type | Description  | Notes
 
 List Filters
 
-Lists all the filters broken out into basic and advanced 
+Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
 
 ### Example
 ```ruby

data/docs/GetRealTimeBreakdownResponse.md

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

data/docs/GetRealTimeHistogramTimeseriesResponse.md

@@ -0,0 +1,11 @@
+# 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] 
+
+

data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md

@@ -0,0 +1,8 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) |  | [optional] 
+
+

data/docs/GetRealTimeTimeseriesResponse.md

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

data/docs/Incident.md

@@ -0,0 +1,28 @@
+# 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] 
+
+

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
+
+
+