Regen from latest OpenAPI spec

.openapi-generator/FILES

@@ -49,6 +49,8 @@ docs/ExportFile.md
 docs/ExportsApi.md
 docs/FilterValue.md
 docs/FiltersApi.md
+docs/GenerateTrackSubtitlesRequest.md
+docs/GenerateTrackSubtitlesResponse.md
 docs/GetAssetInputInfoResponse.md
 docs/GetAssetOrLiveStreamIdResponse.md
 docs/GetAssetOrLiveStreamIdResponseData.md
@@ -242,6 +244,8 @@ lib/mux_ruby/models/error.rb
 lib/mux_ruby/models/export_date.rb
 lib/mux_ruby/models/export_file.rb
 lib/mux_ruby/models/filter_value.rb
+lib/mux_ruby/models/generate_track_subtitles_request.rb
+lib/mux_ruby/models/generate_track_subtitles_response.rb
 lib/mux_ruby/models/get_asset_input_info_response.rb
 lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb
 lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb
@@ -363,4 +367,6 @@ lib/mux_ruby/version.rb
 mux_ruby.gemspec
 spec/api_client_spec.rb
 spec/configuration_spec.rb
+spec/models/generate_track_subtitles_request_spec.rb
+spec/models/generate_track_subtitles_response_spec.rb
 spec/spec_helper.rb

Gemfile.lock

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

README.md

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

docs/Asset.md

@@ -31,6 +31,7 @@
 | **recording_times** | [**Array<AssetRecordingTimes>**](AssetRecordingTimes.md) | An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream. Additionally any time slate media is inserted during brief interruptions in the live stream media or times when the live streaming software disconnects, a recording session representing the slate media will be added with a \"slate\" type. | [optional] |
 | **non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) |  | [optional] |
 | **test** | **Boolean** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] |
+| **ingest_type** | **String** | The type of ingest used to create the asset. | [optional] |
 
 ## Example
 
@@ -64,7 +65,8 @@ instance = MuxRuby::Asset.new(
   static_renditions: null,
   recording_times: null,
   non_standard_input_reasons: null,
-  test: null
+  test: null,
+  ingest_type: null
 )
 ```
 

docs/AssetsApi.md

@@ -10,11 +10,12 @@ All URIs are relative to *https://api.mux.com*
 | [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset |
 | [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
 | [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track |
+| [**generate_asset_track_subtitles**](AssetsApi.md#generate_asset_track_subtitles) | **POST** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles | Generate track subtitles |
 | [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
 | [**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**](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 |
 
@@ -444,6 +445,80 @@ nil (empty response body)
 - **Accept**: Not defined
 
 
+## generate_asset_track_subtitles
+
+> <GenerateTrackSubtitlesResponse> generate_asset_track_subtitles(asset_id, track_id, generate_track_subtitles_request)
+
+Generate track subtitles
+
+Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created.
+
+### 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.
+track_id = 'track_id_example' # String | The track ID.
+generate_track_subtitles_request = MuxRuby::GenerateTrackSubtitlesRequest.new # GenerateTrackSubtitlesRequest | 
+
+begin
+  # Generate track subtitles
+  result = api_instance.generate_asset_track_subtitles(asset_id, track_id, generate_track_subtitles_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AssetsApi->generate_asset_track_subtitles: #{e}"
+end
+```
+
+#### Using the generate_asset_track_subtitles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateTrackSubtitlesResponse>, Integer, Hash)> generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request)
+
+```ruby
+begin
+  # Generate track subtitles
+  data, status_code, headers = api_instance.generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateTrackSubtitlesResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling AssetsApi->generate_asset_track_subtitles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asset_id** | **String** | The asset ID. |  |
+| **track_id** | **String** | The track ID. |  |
+| **generate_track_subtitles_request** | [**GenerateTrackSubtitlesRequest**](GenerateTrackSubtitlesRequest.md) |  |  |
+
+### Return type
+
+[**GenerateTrackSubtitlesResponse**](GenerateTrackSubtitlesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_asset
 
 > <AssetResponse> get_asset(asset_id)
@@ -738,7 +813,7 @@ end
 
 > <AssetResponse> update_asset(asset_id, update_asset_request)
 
-Update an Asset
+Update an asset
 
 Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
 
@@ -759,7 +834,7 @@ asset_id = 'asset_id_example' # String | The asset ID.
 update_asset_request = MuxRuby::UpdateAssetRequest.new # UpdateAssetRequest | 
 
 begin
-  # Update an Asset
+  # Update an asset
   result = api_instance.update_asset(asset_id, update_asset_request)
   p result
 rescue MuxRuby::ApiError => e
@@ -775,7 +850,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update an Asset
+  # 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 # => { ... }

docs/CreateSimulcastTargetRequest.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **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`. | [optional] |
+| **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. | [optional] |
+| **url** | **String** | The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`.  Note: SRT simulcast targets can only be used when an source is connected over SRT.  | [optional] |
 
 ## Example
 

docs/Error.md

@@ -12,6 +12,7 @@
 | **description** | **String** | Description of the error. | [optional] |
 | **count** | **Integer** | The total number of views that experienced this error. | [optional] |
 | **code** | **Integer** | The error code | [optional] |
+| **player_error_code** | **String** | The string version of the error code | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = MuxRuby::Error.new(
   last_seen: null,
   description: null,
   count: null,
-  code: null
+  code: null,
+  player_error_code: null
 )
 ```
 

docs/GenerateTrackSubtitlesRequest.md

@@ -0,0 +1,18 @@
+# MuxRuby::GenerateTrackSubtitlesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::GenerateTrackSubtitlesRequest.new(
+  generated_subtitles: null
+)
+```
+

docs/GenerateTrackSubtitlesResponse.md

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

docs/InputSettings.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `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/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * 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. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input.  | [optional] |
 | **overlay_settings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) |  | [optional] |
-| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [optional] |
+| **generated_subtitles** | [**Array<AssetGeneratedSubtitleSettings>**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition with this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`. | [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 `text` type tracks. | [optional] |

docs/LiveStream.md

@@ -26,6 +26,7 @@
 | **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] |
 | **srt_passphrase** | **String** | Unique key used for encrypting a stream to a Mux SRT endpoint. | [optional] |
+| **active_ingest_protocol** | **String** | The protocol used for the active ingest stream. This is only set when the live stream is active. | [optional] |
 
 ## Example
 
@@ -54,7 +55,8 @@ instance = MuxRuby::LiveStream.new(
   latency_mode: null,
   test: null,
   max_continuous_duration: null,
-  srt_passphrase: null
+  srt_passphrase: null,
+  active_ingest_protocol: null
 )
 ```