mux_ruby 2.2.0 → 3.11.1

data/docs/LiveStream.md

@@ -8,17 +8,23 @@
 | **created_at** | **String** | Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
 | **stream_key** | **String** | Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming. | [optional] |
 | **active_asset_id** | **String** | The Asset that is currently being created if there is an active broadcast. | [optional] |
-| **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Assets that were created from this live stream. | [optional] |
-| **status** | **String** | `idle` indicates that there is no active broadcast. `active` indicates that there is an active broadcast and `disabled` status indicates that no future RTMP streams can be published. | [optional] |
+| **recent_asset_ids** | **Array<String>** | An array of strings with the most recent Asset IDs that were created from this Live Stream. The most recently generated Asset ID is the last entry in the list. | [optional] |
+| **status** | [**LiveStreamStatus**](LiveStreamStatus.md) |  | [optional] |
 | **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
 | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] |
-| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
 | **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
-| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
-| **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
-| **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
+| **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [optional] |
+| **generated_subtitles** | [**Array<LiveStreamGeneratedSubtitleSettings>**](LiveStreamGeneratedSubtitleSettings.md) | Configure the incoming live stream to include subtitles created with automatic speech recognition. Each Asset created from a live stream with `generated_subtitles` configured will automatically receive two text tracks. The first of these will have a `text_source` value of `generated_live`, and will be available with `ready` status as soon as the stream is live. The second text track will have a `text_source` value of `generated_live_final` and will contain subtitles with improved accuracy, timing, and formatting. However, `generated_live_final` tracks will not be available in `ready` status until the live stream ends. If an Asset has both `generated_live` and `generated_live_final` tracks that are `ready`, then only the `generated_live_final` track will be included during playback. | [optional] |
+| **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Max**: 1800s (30 minutes).  If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams.  Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option.  | [optional][default to 60] |
+| **use_slate_for_standard_latency** | **Boolean** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional][default to false] |
+| **reconnect_slate_url** | **String** | The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used. | [optional] |
+| **reduced_latency** | **Boolean** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
+| **low_latency** | **Boolean** | This field is deprecated. Please use `latency_mode` instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. | [optional] |
 | **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \"restream\") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
+| **latency_mode** | **String** | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
 | **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
+| **max_continuous_duration** | **Integer** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional][default to 43200] |
 
 ## Example
 
@@ -36,11 +42,17 @@ instance = MuxRuby::LiveStream.new(
   new_asset_settings: null,
   passthrough: null,
   audio_only: null,
+  embedded_subtitles: null,
+  generated_subtitles: null,
   reconnect_window: null,
+  use_slate_for_standard_latency: null,
+  reconnect_slate_url: null,
   reduced_latency: null,
   low_latency: null,
   simulcast_targets: null,
-  test: null
+  latency_mode: null,
+  test: null,
+  max_continuous_duration: null
 )
 ```
 

data/docs/LiveStreamEmbeddedSubtitleSettings.md

@@ -0,0 +1,24 @@
+# MuxRuby::LiveStreamEmbeddedSubtitleSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for this live stream closed caption track. | [optional] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters. | [optional] |
+| **language_code** | **String** | The language of the closed caption stream. Value must be BCP 47 compliant. | [optional][default to 'en'] |
+| **language_channel** | **String** | CEA-608 caption channel to read data from. | [optional][default to 'cc1'] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::LiveStreamEmbeddedSubtitleSettings.new(
+  name: null,
+  passthrough: null,
+  language_code: null,
+  language_channel: null
+)
+```
+

data/docs/LiveStreamGeneratedSubtitleSettings.md

@@ -0,0 +1,24 @@
+# MuxRuby::LiveStreamGeneratedSubtitleSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for this live stream subtitle track. | [optional] |
+| **passthrough** | **String** | Arbitrary metadata set for the live stream subtitle track. Max 255 characters. | [optional] |
+| **language_code** | **String** | The language to generate subtitles in. | [optional][default to 'en'] |
+| **transcription_vocabulary_ids** | **Array<String>** | Unique identifiers for existing Transcription Vocabularies to use while generating subtitles for the live stream. If the Transcription Vocabularies provided collectively have more than 1000 phrases, only the first 1000 phrases will be included. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::LiveStreamGeneratedSubtitleSettings.new(
+  name: null,
+  passthrough: null,
+  language_code: null,
+  transcription_vocabulary_ids: null
+)
+```
+

data/docs/LiveStreamResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**LiveStream**](.md) |  | [optional] |
+| **data** | [**LiveStream**](LiveStream.md) |  | [optional] |
 
 ## Example
 

data/docs/LiveStreamStatus.md

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

data/docs/LiveStreamsApi.md

@@ -16,8 +16,11 @@ All URIs are relative to *https://api.mux.com*
 | [**get_live_stream_playback_id**](LiveStreamsApi.md#get_live_stream_playback_id) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a live stream playback ID |
 | [**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 |
-| [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream’s stream key |
+| [**reset_stream_key**](LiveStreamsApi.md#reset_stream_key) | **POST** /video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key | Reset a live stream's stream key |
 | [**signal_live_stream_complete**](LiveStreamsApi.md#signal_live_stream_complete) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/complete | Signal a live stream is finished |
+| [**update_live_stream**](LiveStreamsApi.md#update_live_stream) | **PATCH** /video/v1/live-streams/{LIVE_STREAM_ID} | Update a live stream |
+| [**update_live_stream_embedded_subtitles**](LiveStreamsApi.md#update_live_stream_embedded_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles | Update a live stream's embedded subtitles |
+| [**update_live_stream_generated_subtitles**](LiveStreamsApi.md#update_live_stream_generated_subtitles) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles | Update a live stream's generated subtitles |
 
 
 ## create_live_stream
@@ -26,6 +29,8 @@ All URIs are relative to *https://api.mux.com*
 
 Create a live stream
 
+Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.
+
 ### Examples
 
 ```ruby
@@ -94,6 +99,8 @@ end
 
 Create a live stream playback ID
 
+Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.
+
 ### Examples
 
 ```ruby
@@ -236,6 +243,8 @@ end
 
 Delete a live stream
 
+Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.
+
 ### Examples
 
 ```ruby
@@ -303,6 +312,8 @@ nil (empty response body)
 
 Delete a live stream playback ID
 
+Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
+
 ### Examples
 
 ```ruby
@@ -653,6 +664,8 @@ end
 
 Retrieve a live stream playback ID
 
+Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.
+
 ### Examples
 
 ```ruby
@@ -795,6 +808,8 @@ end
 
 List live streams
 
+Lists the live streams that currently exist in the current environment.
+
 ### Examples
 
 ```ruby
@@ -811,7 +826,8 @@ api_instance = MuxRuby::LiveStreamsApi.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`
-  stream_key: 'stream_key_example' # String | Filter response to return live stream for this stream key only
+  stream_key: 'stream_key_example', # String | Filter response to return live stream for this stream key only
+  status: MuxRuby::LiveStreamStatus::ACTIVE # LiveStreamStatus | Filter response to return live streams with the specified status only
 }
 
 begin
@@ -848,6 +864,7 @@ end
 | **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] |
 | **stream_key** | **String** | Filter response to return live stream for this stream key only | [optional] |
+| **status** | [**LiveStreamStatus**](.md) | Filter response to return live streams with the specified status only | [optional] |
 
 ### Return type
 
@@ -867,7 +884,7 @@ end
 
 > <LiveStreamResponse> reset_stream_key(live_stream_id)
 
-Reset a live stream’s stream key
+Reset a live stream's stream key
 
 Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
 
@@ -887,7 +904,7 @@ api_instance = MuxRuby::LiveStreamsApi.new
 live_stream_id = 'live_stream_id_example' # String | The live stream ID
 
 begin
-  # Reset a live stream’s stream key
+  # Reset a live stream's stream key
   result = api_instance.reset_stream_key(live_stream_id)
   p result
 rescue MuxRuby::ApiError => e
@@ -903,7 +920,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Reset a live stream’s stream key
+  # Reset a live stream's stream key
   data, status_code, headers = api_instance.reset_stream_key_with_http_info(live_stream_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -1002,3 +1019,219 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## update_live_stream
+
+> <LiveStreamResponse> update_live_stream(live_stream_id, update_live_stream_request)
+
+Update a live stream
+
+Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+update_live_stream_request = MuxRuby::UpdateLiveStreamRequest.new # UpdateLiveStreamRequest | 
+
+begin
+  # Update a live stream
+  result = api_instance.update_live_stream(live_stream_id, update_live_stream_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream: #{e}"
+end
+```
+
+#### Using the update_live_stream_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
+
+```ruby
+begin
+  # Update a live stream
+  data, status_code, headers = api_instance.update_live_stream_with_http_info(live_stream_id, update_live_stream_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **update_live_stream_request** | [**UpdateLiveStreamRequest**](UpdateLiveStreamRequest.md) |  |  |
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_live_stream_embedded_subtitles
+
+> <LiveStreamResponse> update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
+
+Update a live stream's embedded subtitles
+
+Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set. 
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+update_live_stream_embedded_subtitles_request = MuxRuby::UpdateLiveStreamEmbeddedSubtitlesRequest.new # UpdateLiveStreamEmbeddedSubtitlesRequest | 
+
+begin
+  # Update a live stream's embedded subtitles
+  result = api_instance.update_live_stream_embedded_subtitles(live_stream_id, update_live_stream_embedded_subtitles_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles: #{e}"
+end
+```
+
+#### Using the update_live_stream_embedded_subtitles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
+
+```ruby
+begin
+  # Update a live stream's embedded subtitles
+  data, status_code, headers = api_instance.update_live_stream_embedded_subtitles_with_http_info(live_stream_id, update_live_stream_embedded_subtitles_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_embedded_subtitles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **update_live_stream_embedded_subtitles_request** | [**UpdateLiveStreamEmbeddedSubtitlesRequest**](UpdateLiveStreamEmbeddedSubtitlesRequest.md) |  |  |
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_live_stream_generated_subtitles
+
+> <LiveStreamResponse> update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
+
+Update a live stream's generated subtitles
+
+Updates a live stream's automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload. 
+
+### 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::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+update_live_stream_generated_subtitles_request = MuxRuby::UpdateLiveStreamGeneratedSubtitlesRequest.new # UpdateLiveStreamGeneratedSubtitlesRequest | 
+
+begin
+  # Update a live stream's generated subtitles
+  result = api_instance.update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_generated_subtitles: #{e}"
+end
+```
+
+#### Using the update_live_stream_generated_subtitles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiveStreamResponse>, Integer, Hash)> update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request)
+
+```ruby
+begin
+  # Update a live stream's generated subtitles
+  data, status_code, headers = api_instance.update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiveStreamResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling LiveStreamsApi->update_live_stream_generated_subtitles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **live_stream_id** | **String** | The live stream ID |  |
+| **update_live_stream_generated_subtitles_request** | [**UpdateLiveStreamGeneratedSubtitlesRequest**](UpdateLiveStreamGeneratedSubtitlesRequest.md) |  |  |
+
+### Return type
+
+[**LiveStreamResponse**](LiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MetricsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
 
 Get metric timeseries data
 
-Returns timeseries data for a specific metric.
+Returns timeseries data for a specific metric.  Each interval represented in the data array contains an array with the following values:   * the first element is the interval time   * the second element is the calculated metric value   * the third element is the number of views in the interval that have a valid metric value 
 
 ### Examples
 
@@ -34,11 +34,11 @@ end
 api_instance = MuxRuby::MetricsApi.new
 metric_id = 'aggregate_startup_time' # String | ID of the Metric
 opts = {
-  timeframe: ['inner_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. 
-  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. 
+  timeframe: ['inner_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` 
+  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
   order_direction: 'asc', # String | Sort order.
-  group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
+  group_by: 'minute' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. 
 }
 
 begin
@@ -73,11 +73,11 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **metric_id** | **String** | ID of the Metric |  |
-| **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] |
-| **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
+| **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
 | **order_direction** | **String** | Sort order. | [optional] |
-| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional] |
+| **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of less than 90 minutes, the default granularity is &#x60;minute&#x60;. Between 90 minutes and 6 hours, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.  | [optional] |
 
 ### Return type
 
@@ -116,8 +116,8 @@ end
 api_instance = MuxRuby::MetricsApi.new
 metric_id = 'aggregate_startup_time' # String | ID of the Metric
 opts = {
-  timeframe: ['inner_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. 
-  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. 
+  timeframe: ['inner_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` 
+  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
 }
 
@@ -153,8 +153,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **metric_id** | **String** | ID of the Metric |  |
-| **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] |
-| **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
+| **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
 
 ### Return type
@@ -193,8 +193,8 @@ end
 
 api_instance = MuxRuby::MetricsApi.new
 opts = {
-  timeframe: ['inner_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. 
-  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. 
+  timeframe: ['inner_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` 
+  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   dimension: 'asn', # String | Dimension the specified value belongs to
   value: 'value_example' # String | Value to show all available metrics for
 }
@@ -230,8 +230,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
-| **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
+| **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
 | **value** | **String** | Value to show all available metrics for | [optional] |
 
@@ -274,12 +274,12 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
 opts = {
   group_by: 'asn', # String | Breakdown value to group the results by
   measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
-  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. 
+  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US` 
   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.
-  timeframe: ['inner_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. 
+  timeframe: ['inner_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
@@ -316,12 +316,12 @@ end
 | **metric_id** | **String** | ID of the Metric |  |
 | **group_by** | **String** | Breakdown value to group the results by | [optional] |
 | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [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] |
+| **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;  | [optional] |
 | **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] |
-| **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] |
+| **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
 
 ### Return type
 
@@ -362,7 +362,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
 opts = {
   measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
   order_direction: 'asc', # String | Sort order.
-  timeframe: ['inner_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. 
+  timeframe: ['inner_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
@@ -399,7 +399,7 @@ end
 | **metric_id** | **String** | ID of the Metric |  |
 | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
 | **order_direction** | **String** | Sort order. | [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] |
+| **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. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60;   * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;  | [optional] |
 
 ### Return type