mux_ruby 2.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c937ce2f7785420b50a766695222406348f91f883995215717db027a7b7c44
-  data.tar.gz: fba6ffdabd6fa52f8e189d46261fc54052a80044dc9856c7d9a5927e1b3d8ad6
+  metadata.gz: a63c390b26263da0a802a7cbce36ad9b2938b39ed68da78099750b59c21a32b4
+  data.tar.gz: 6a52eba37eeb1b825eb169d852a73a141f07b339dd38f4de6ffbc428dab0bdf9
 SHA512:
-  metadata.gz: ac85c2e8118ca383192f7fd4e416bacb06b3715fc863cd0d29aa5e8d8c60c0801ced666a051766616f7ad5755cb3e58e278ed9c139c254d91589b8c78460cb58
-  data.tar.gz: 8dd842dd4222c06018d9daa2d6b9b5a2698346cd38f5192e7ac942c69d6e461e37e17fb2b9c3d9e04ec5c1055e37765ca28af03d10100583d48e10e659cf3490
+  metadata.gz: dddc47ce920e32ba44a453af1504f3b790a690c69bf9465e090a912c823012c51a1c4c5e20d39f117b89087256921d8ec2f155bf9b16abd2dc56fbe271192cc6
+  data.tar.gz: ca207a01923be742f9836f4cd1703ab9d5018e782f790d824bc56390c55884e3780b9d08e91b4a7824928d534b778c49f8c996b06e0fee71c44036470575fe99

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (2.1.1)
+    mux_ruby (3.2.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     byebug (11.1.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
     ffi (1.15.4)
     jaro_winkler (1.5.4)
@@ -67,4 +67,4 @@ DEPENDENCIES
   solid_assert
 
 BUNDLED WITH
-   2.2.27
+   2.2.33

data/README.md

@@ -17,7 +17,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: 2.1.1
+- Package version: 3.2.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://docs.mux.com](https://docs.mux.com)
 
@@ -34,16 +34,16 @@ gem build mux_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mux_ruby-2.1.1.gem
+gem install ./mux_ruby-3.2.0.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-2.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-3.2.0.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', '~> 2.1.1'
+    gem 'mux_ruby', '~> 3.2.0'
 
 ### Install from Git
 

data/docs/Asset.md

@@ -17,7 +17,7 @@
 | **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] |
-| **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] |
 | **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] |
 | **master_access** | **String** |  | [optional][default to 'none'] |

data/docs/AssetNonStandardInputReasons.md

@@ -9,6 +9,7 @@
 | **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_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] |
 | **video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. | [optional] |
 | **audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. | [optional] |
@@ -25,6 +26,7 @@ instance = MuxRuby::AssetNonStandardInputReasons.new(
   video_gop_size: null,
   video_frame_rate: null,
   video_resolution: null,
+  video_bitrate: null,
   pixel_aspect_ratio: null,
   video_edit_list: null,
   audio_edit_list: null,

data/docs/AssetsApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://api.mux.com*
 | [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
 | [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID |
 | [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets |
+| [**update_asset**](AssetsApi.md#update_asset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an Asset |
 | [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access |
 | [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
 
@@ -725,6 +726,78 @@ end
 - **Accept**: application/json
 
 
+## update_asset
+
+> <AssetResponse> update_asset(asset_id, update_asset_request)
+
+Update an Asset
+
+Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
+
+### 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::AssetsApi.new
+asset_id = 'asset_id_example' # String | The asset ID.
+update_asset_request = MuxRuby::UpdateAssetRequest.new # UpdateAssetRequest | 
+
+begin
+  # Update an Asset
+  result = api_instance.update_asset(asset_id, update_asset_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AssetsApi->update_asset: #{e}"
+end
+```
+
+#### Using the update_asset_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AssetResponse>, Integer, Hash)> update_asset_with_http_info(asset_id, update_asset_request)
+
+```ruby
+begin
+  # Update an Asset
+  data, status_code, headers = api_instance.update_asset_with_http_info(asset_id, update_asset_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AssetResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AssetsApi->update_asset_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asset_id** | **String** | The asset ID. |  |
+| **update_asset_request** | [**UpdateAssetRequest**](UpdateAssetRequest.md) |  |  |
+
+### Return type
+
+[**AssetResponse**](AssetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_asset_master_access
 
 > <AssetResponse> update_asset_master_access(asset_id, update_asset_master_access_request)

data/docs/CreateAssetRequest.md

@@ -7,7 +7,7 @@
 | **input** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] |
 | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `\"public\"` (anyone with the playback URL can stream the asset). And `\"signed\"` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
 | **per_title_encode** | **Boolean** |  | [optional] |
-| **passthrough** | **String** | Arbitrary metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
 | **mp4_support** | **String** | Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] |
 | **normalize_audio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional][default to false] |
 | **master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](/guides/video/download-your-videos) for more information. | [optional] |

data/docs/CreateLiveStreamRequest.md

@@ -9,8 +9,10 @@
 | **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. Defaults to 60 seconds on the API if not specified. | [optional] |
 | **passthrough** | **String** |  | [optional] |
 | **audio_only** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] |
-| **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. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [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) | Describe the embedded closed caption contents of the incoming live stream. | [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. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [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. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [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** | 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] |
 
@@ -25,8 +27,10 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
   reconnect_window: null,
   passthrough: null,
   audio_only: null,
+  embedded_subtitles: null,
   reduced_latency: null,
   low_latency: null,
+  latency_mode: null,
   test: null,
   simulcast_targets: null
 )

data/docs/CreatePlaybackRestrictionRequest.md

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

data/docs/CreateSimulcastTargetRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **passthrough** | **String** | Arbitrary metadata set by you when creating a simulcast target. | [optional] |
+| **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'. |  |
 

data/docs/CreateTrackRequest.md

@@ -10,7 +10,7 @@
 | **language_code** | **String** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. |  |
 | **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] |
 | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] |
-| **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. | [optional] |
+| **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. | [optional] |
 
 ## Example
 

data/docs/DeliveryUsageApi.md

@@ -31,7 +31,8 @@ api_instance = MuxRuby::DeliveryUsageApi.new
 opts = {
   page: 56, # Integer | Offset by this many pages, of the size of `limit`
   limit: 56, # Integer | Number of items to include in the response
-  asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
+  asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
+  live_stream_id: 'live_stream_id_example', # String | Filter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
   timeframe: ['inner_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
 }
 
@@ -68,7 +69,8 @@ end
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
 | **limit** | **Integer** | Number of items to include in the response | [optional][default to 100] |
-| **asset_id** | **String** | Filter response to return delivery usage for this asset only. | [optional] |
+| **asset_id** | **String** | Filter response to return delivery usage for this asset only. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together. | [optional] |
+| **live_stream_id** | **String** | Filter response to return delivery usage for assets for this live stream. You cannot specify both the &#x60;asset_id&#x60; and &#x60;live_stream_id&#x60; parameters together. | [optional] |
 | **timeframe** | [**Array&lt;String&gt;**](String.md) | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional] |
 
 ### Return type

data/docs/DimensionsApi.md

@@ -33,8 +33,8 @@ dimension_id = 'abcd1234' # String | ID of the Dimension
 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`
-  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` 
+  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
@@ -71,8 +71,8 @@ end
 | **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] |
+| **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] |
+| **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
 

data/docs/ErrorsApi.md

@@ -29,8 +29,8 @@ end
 
 api_instance = MuxRuby::ErrorsApi.new
 opts = {
-  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` 
+  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
@@ -64,8 +64,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
+| **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] |
+| **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
 

data/docs/ExportsApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
 
 List property video view export links
 
-Deprecated: The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them. 
+The API has been replaced by the list-exports-views API call.  Lists the available video view exports along with URLs to retrieve them. 
 
 ### Examples
 

data/docs/FiltersApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
 
 Lists values for a specific filter
 
-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. 
+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. 
 
 ### Examples
 
@@ -33,8 +33,8 @@ filter_id = 'abcd1234' # String | ID of the Filter
 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`
-  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` 
+  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
@@ -71,8 +71,8 @@ end
 | **filter_id** | **String** | ID of the Filter |  |
 | **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] |
+| **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] |
+| **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
 
@@ -94,7 +94,7 @@ end
 
 List Filters
 
-Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
+The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
 
 ### Examples
 

data/docs/GetLiveStreamPlaybackIDResponse.md

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

data/docs/InputSettings.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **url** | **String** | The web address of the file that Mux should download and use. * For subtitles text tracks, the url is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the url is the location of the watermark image. * When creating clips from existing Mux assets, the url is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from.  | [optional] |
+| **url** | **String** | The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from.  | [optional] |
 | **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] |

data/docs/LiveStream.md

@@ -12,12 +12,14 @@
 | **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] |
 | **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] |
+| **embedded_subtitles** | [**Array<LiveStreamEmbeddedSubtitleSettings>**](LiveStreamEmbeddedSubtitleSettings.md) | Describes the embedded closed caption configuration of the incoming live stream. | [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] |
+| **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. **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** | 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. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [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. 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] |
 
 ## Example
@@ -36,10 +38,12 @@ instance = MuxRuby::LiveStream.new(
   new_asset_settings: null,
   passthrough: null,
   audio_only: null,
+  embedded_subtitles: null,
   reconnect_window: null,
   reduced_latency: null,
   low_latency: null,
   simulcast_targets: null,
+  latency_mode: null,
   test: 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
+)
+```
+