mux_ruby 3.3.1 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa2b08545d6b8941ea2e14589be5e5f1caa824b34bbf1aa94cdc0a9ec5ed49f
-  data.tar.gz: e4d38cf3dcf1a2e797475414b3d98ad8b30f5c4c9d4b853f51cfed1673f9fb29
+  metadata.gz: abd3fbe606bb7ce4df59507592aff18e57d872ada172147a4961f0ccbe6ee41d
+  data.tar.gz: 77eef8d8a0f203f7a9129ffa4fb78d6942538263a236f0e454b28a43a5460e09
 SHA512:
-  metadata.gz: 443210ca73ae9483681dbaf3f57b184851483a310590c16a8932a0aa16f02e26d64d43e83a4cc3420615202c5fb089961cfce4877e9c67d8f9aab90f1bb844f7
-  data.tar.gz: 4cf2ff058d777f4149162e4a023d3c4ad679e02faac52e50ebac69f9c6ab4bff04bfaf5ff7b67f30c073795630cdcc4cde8a28384761fe40317c1d5e4bd0e475
+  metadata.gz: a8b77a6218923a14c88f8072c8c957c06e0a5c4e377f9ac46df2b18af3441993e761e641105b1358b8d7171731ce0181e95f010d79a7158114d4d8567ddd5f3d
+  data.tar.gz: 8a4621013a5051633075b6192946a0e34dea208090b41fa02e20b8f9eddb6b391235c102b473631034789039bcb35e063e48e9b5d9ec445b2be01a89880f120e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (3.3.1)
+    mux_ruby (3.5.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -1,8 +1,14 @@
 ![Mux Ruby Banner](github-ruby-sdk.png)
 
-![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
-
-MuxRuby - the Ruby gem for the Mux API
+<p align="center">
+  <a href="https://rubygems.org/gems/mux_ruby"><img src="https://img.shields.io/gem/v/mux_ruby" title="RubyGems" /></a>
+  <a href="https://github.com/muxinc/mux-ruby/workflows/ci.yaml"><img src="https://github.com/muxinc/mux-ruby/actions/workflows/ci.yaml/badge.svg" title="CI" /></a>
+</p>
+<p align="center">
+  <a href="https://rubygems.org/gems/mux_ruby">RubyGems</a> |
+  <a href="https://docs.mux.com">Mux Docs</a> |
+  <a href="https://docs.mux.com/api-reference">Mux API Reference </a>
+</p>
 
 # Mux Ruby
 
@@ -17,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 3.3.1
+- Package version: 3.5.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.mux.com](https://docs.mux.com)
 
@@ -34,16 +40,16 @@ gem build mux_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mux_ruby-3.3.1.gem
+gem install ./mux_ruby-3.5.1.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-3.3.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-3.5.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'mux_ruby', '~> 3.3.1'
+    gem 'mux_ruby', '~> 3.5.1'
 
 ### Install from Git
 

data/docs/Asset.md

@@ -16,7 +16,7 @@
 | **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] |
 | **per_title_encode** | **Boolean** |  | [optional] |
 | **upload_id** | **String** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional] |
-| **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] |
+| **is_live** | **Boolean** | Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. | [optional] |
 | **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
 | **live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] |
 | **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] |

data/docs/AssetNonStandardInputReasons.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **video_codec** | **String** | The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. | [optional] |
 | **audio_codec** | **String** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional] |
-| **video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 10 seconds. | [optional] |
-| **video_frame_rate** | **String** | The video frame rate of the input file. Video with average frames per second (fps) less than 10 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] |
+| **video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 20 seconds. | [optional] |
+| **video_frame_rate** | **String** | The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] |
 | **video_resolution** | **String** | The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels. | [optional] |
 | **video_bitrate** | **String** | The video bitrate of the input file is `high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps. | [optional] |
 | **pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file. | [optional] |

data/docs/AssetResponse.md

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

data/docs/AssetsApi.md

@@ -95,6 +95,8 @@ end
 
 Create a playback ID
 
+Creates a playback ID that can be used to stream the asset to a viewer.
+
 ### Examples
 
 ```ruby
@@ -165,6 +167,8 @@ end
 
 Create an asset track
 
+Adds an asset track (for example, subtitles) to an asset.
+
 ### Examples
 
 ```ruby
@@ -304,6 +308,8 @@ nil (empty response body)
 
 Delete a playback ID
 
+Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration.
+
 ### Examples
 
 ```ruby
@@ -584,6 +590,8 @@ end
 
 Retrieve a playback ID
 
+Retrieves information about the specified playback ID.
+
 ### Examples
 
 ```ruby

data/docs/Broadcast.md

@@ -0,0 +1,30 @@
+# MuxRuby::Broadcast
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the broadcast. Max 255 characters. |  |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
+| **live_stream_id** | **String** | The ID of the live stream that the broadcast will be sent to. |  |
+| **status** | [**BroadcastStatus**](BroadcastStatus.md) |  |  |
+| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [default to 'gallery'] |
+| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
+| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) |  | [default to '1920x1080'] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Broadcast.new(
+  id: null,
+  passthrough: null,
+  live_stream_id: null,
+  status: null,
+  layout: null,
+  background: null,
+  resolution: null
+)
+```
+

data/docs/BroadcastLayout.md

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

data/docs/BroadcastResolution.md

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

data/docs/BroadcastResponse.md

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

data/docs/BroadcastStatus.md

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

data/docs/CreateBroadcastRequest.md

@@ -0,0 +1,26 @@
+# MuxRuby::CreateBroadcastRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
+| **live_stream_id** | **String** | The ID of the live stream that you want to broadcast to. |  |
+| **layout** | [**BroadcastLayout**](BroadcastLayout.md) |  | [optional][default to 'gallery'] |
+| **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
+| **resolution** | [**BroadcastResolution**](BroadcastResolution.md) |  | [optional][default to '1920x1080'] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateBroadcastRequest.new(
+  passthrough: null,
+  live_stream_id: null,
+  layout: null,
+  background: null,
+  resolution: null
+)
+```
+

data/docs/CreateLiveStreamRequest.md

@@ -15,6 +15,7 @@
 | **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. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/ | [optional] |
 | **test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams 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] |
 | **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) |  | [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
 
@@ -32,7 +33,8 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
   low_latency: null,
   latency_mode: null,
   test: null,
-  simulcast_targets: null
+  simulcast_targets: null,
+  max_continuous_duration: null
 )
 ```
 

data/docs/CreatePlaybackIDResponse.md

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

data/docs/CreatePlaybackRestrictionRequest.md

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

data/docs/CreateSimulcastTargetRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
 | **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
-| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: 'rtmp://live.example.com/app'. |  |
+| **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: `rtmp://live.example.com/app`. |  |
 
 ## Example
 

data/docs/CreateSpaceRequest.md

@@ -0,0 +1,22 @@
+# MuxRuby::CreateSpaceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**SpaceType**](SpaceType.md) |  | [optional][default to 'server'] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
+| **broadcasts** | [**Array<CreateBroadcastRequest>**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::CreateSpaceRequest.new(
+  type: null,
+  passthrough: null,
+  broadcasts: null
+)
+```
+

data/docs/CreateTrackResponse.md

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

data/docs/DirectUploadsApi.md

@@ -86,6 +86,8 @@ end
 
 Create a new direct upload URL
 
+Creates a new direct upload, through which video content can be uploaded for ingest to Mux.
+
 ### Examples
 
 ```ruby
@@ -154,6 +156,8 @@ end
 
 Retrieve a single direct upload's info
 
+Fetches information about a single direct upload in the current environment.
+
 ### Examples
 
 ```ruby
@@ -222,6 +226,8 @@ end
 
 List direct uploads
 
+Lists currently extant direct uploads in the current environment.
+
 ### Examples
 
 ```ruby

data/docs/GetAssetPlaybackIDResponse.md

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

data/docs/GetLiveStreamPlaybackIDResponse.md

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

data/docs/IncidentResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**Incident**](.md) |  | [optional] |
+| **data** | [**Incident**](Incident.md) |  | [optional] |
 | **timeframe** | **Array<Integer>** |  | [optional] |
 
 ## Example

data/docs/InputSettings.md

@@ -8,10 +8,10 @@
 | **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] |
 | **start_time** | **Float** | The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
 | **end_time** | **Float** | The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. | [optional] |
-| **type** | **String** | This parameter is required for the `text` track type. | [optional] |
-| **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` track type. | [optional] |
+| **type** | **String** | This parameter is required for `text` type tracks. | [optional] |
+| **text_type** | **String** | Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. | [optional] |
 | **language_code** | **String** | The language code value must be a valid [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, en for English or en-US for the US version of English. This parameter is required for text type and subtitles text type track. | [optional] |
-| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type track. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
+| **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be \"English\" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. | [optional] |
 | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
 | **passthrough** | **String** | This optional parameter should be used for `text` type and subtitles `text` type tracks. | [optional] |
 

data/docs/ListSpacesResponse.md

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

data/docs/LiveStream.md

@@ -21,6 +21,7 @@
 | **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. Note: Reconnect windows are incompatible with Reduced Latency and Low Latency and will always be set to zero (0) seconds. 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
 
@@ -44,7 +45,8 @@ instance = MuxRuby::LiveStream.new(
   low_latency: null,
   simulcast_targets: null,
   latency_mode: null,
-  test: null
+  test: null,
+  max_continuous_duration: 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/LiveStreamsApi.md

@@ -16,7 +16,7 @@ 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 |
@@ -28,6 +28,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
@@ -96,6 +98,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
@@ -238,6 +242,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
@@ -305,6 +311,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
@@ -655,6 +663,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
@@ -797,6 +807,8 @@ end
 
 List live streams
 
+Lists the live streams that currently exist in the current environment.
+
 ### Examples
 
 ```ruby
@@ -871,7 +883,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.
 
@@ -891,7 +903,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
@@ -907,7 +919,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 # => { ... }

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.  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 
+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
 
@@ -38,7 +38,7 @@ opts = {
   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 timeframe.  For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. 
+  group_by: 'ten_minutes' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.  For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity. 
 }
 
 begin
@@ -77,7 +77,7 @@ end
 | **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 timeframe.  For timeframes of 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 hours inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 hours is &#x60;day&#x60;. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity.  | [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 6 hours or less, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 hours inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 hours is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.  | [optional] |
 
 ### Return type
 

data/docs/PlaybackRestrictionResponse.md

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