v3.16.0 (#80)

muxinc · May 7, 2024 · 14f52d8 · 14f52d8
1 parent b5a9876
commit 14f52d8
Show file tree

Hide file tree

Showing 35 changed files with 1,538 additions and 43 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -167,13 +167,17 @@ docs/UpdateAssetMasterAccessRequest.md
 docs/UpdateAssetRequest.md
 docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
 docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
+docs/UpdateLiveStreamNewAssetSettings.md
 docs/UpdateLiveStreamRequest.md
 docs/UpdateReferrerDomainRestrictionRequest.md
 docs/UpdateTranscriptionVocabularyRequest.md
+docs/UpdateUserAgentRestrictionRequest.md
 docs/UpdateWebInputUrlRequest.md
 docs/Upload.md
 docs/UploadError.md
 docs/UploadResponse.md
+docs/UserAgentRestrictionRequest.md
+docs/UserAgentRestrictionSettings.md
 docs/VideoView.md
 docs/VideoViewEvent.md
 docs/VideoViewResponse.md
@@ -351,13 +355,17 @@ lib/mux_ruby/models/update_asset_mp4_support_request.rb
 lib/mux_ruby/models/update_asset_request.rb
 lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb
 lib/mux_ruby/models/update_live_stream_generated_subtitles_request.rb
+lib/mux_ruby/models/update_live_stream_new_asset_settings.rb
 lib/mux_ruby/models/update_live_stream_request.rb
 lib/mux_ruby/models/update_referrer_domain_restriction_request.rb
 lib/mux_ruby/models/update_transcription_vocabulary_request.rb
+lib/mux_ruby/models/update_user_agent_restriction_request.rb
 lib/mux_ruby/models/update_web_input_url_request.rb
 lib/mux_ruby/models/upload.rb
 lib/mux_ruby/models/upload_error.rb
 lib/mux_ruby/models/upload_response.rb
+lib/mux_ruby/models/user_agent_restriction_request.rb
+lib/mux_ruby/models/user_agent_restriction_settings.rb
 lib/mux_ruby/models/video_view.rb
 lib/mux_ruby/models/video_view_event.rb
 lib/mux_ruby/models/video_view_response.rb
@@ -367,4 +375,8 @@ lib/mux_ruby/version.rb
 mux_ruby.gemspec
 spec/api_client_spec.rb
 spec/configuration_spec.rb
+spec/models/update_live_stream_new_asset_settings_spec.rb
+spec/models/update_user_agent_restriction_request_spec.rb
+spec/models/user_agent_restriction_request_spec.rb
+spec/models/user_agent_restriction_settings_spec.rb
 spec/spec_helper.rb
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mux_ruby (3.15.0)
+    mux_ruby (3.16.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

diff --git a/README.md b/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.15.0
+- Package version: 3.16.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.15.0.gem
+gem install ./mux_ruby-3.16.0.gem
 ```
 
-(for development, run `gem install --dev ./mux_ruby-3.15.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./mux_ruby-3.16.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.15.0'
+    gem 'mux_ruby', '~> 3.16.0'
 
 ### Install from Git
 

diff --git a/docs/AbridgedVideoView.md b/docs/AbridgedVideoView.md
@@ -17,6 +17,7 @@
 | **view_end** | **String** |  | [optional] |
 | **viewer_experience_score** | **Float** |  | [optional] |
 | **watch_time** | **Integer** |  | [optional] |
+| **playback_failure** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -36,7 +37,8 @@ instance = MuxRuby::AbridgedVideoView.new(
   view_start: null,
   view_end: null,
   viewer_experience_score: null,
-  watch_time: null
+  watch_time: null,
+  playback_failure: null
 )
 ```
 
diff --git a/docs/CreatePlaybackRestrictionRequest.md b/docs/CreatePlaybackRestrictionRequest.md
@@ -5,14 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) |  | [optional] |
+| **user_agent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'mux_ruby'
 
 instance = MuxRuby::CreatePlaybackRestrictionRequest.new(
-  referrer: null
+  referrer: null,
+  user_agent: null
 )
 ```
 
diff --git a/docs/DeliveryReport.md b/docs/DeliveryReport.md
@@ -12,6 +12,7 @@
 | **asset_state** | **String** | The state of the asset. | [optional] |
 | **asset_duration** | **Float** | The duration of the asset in seconds. | [optional] |
 | **asset_resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest &amp; storage | [optional] |
+| **asset_encoding_tier** | **String** | The encoding tier that the asset was ingested at. [See the encoding tiers guide for more details.](https://docs.mux.com/guides/use-encoding-tiers) | [optional] |
 | **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
 | **delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) |  | [optional] |
 
@@ -29,6 +30,7 @@ instance = MuxRuby::DeliveryReport.new(
   asset_state: null,
   asset_duration: null,
   asset_resolution_tier: null,
+  asset_encoding_tier: null,
   delivered_seconds: null,
   delivered_seconds_by_resolution: null
 )

diff --git a/docs/GenerateTrackSubtitlesResponse.md b/docs/GenerateTrackSubtitlesResponse.md
@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**Track**](Track.md) |  | [optional] |
+| **data** | [**Array&lt;Track&gt;**](Track.md) |  | [optional] |
 
 ## Example
 

diff --git a/docs/PlaybackRestriction.md b/docs/PlaybackRestriction.md
@@ -8,6 +8,7 @@
 | **created_at** | **String** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
 | **updated_at** | **String** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
 | **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) |  | [optional] |
+| **user_agent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.md) |  | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = MuxRuby::PlaybackRestriction.new(
   id: null,
   created_at: null,
   updated_at: null,
-  referrer: null
+  referrer: null,
+  user_agent: null
 )
 ```
 
diff --git a/docs/PlaybackRestrictionsApi.md b/docs/PlaybackRestrictionsApi.md
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.mux.com*
 | [**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction |
 | [**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions |
 | [**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction |
+| [**update_user_agent_restriction**](PlaybackRestrictionsApi.md#update_user_agent_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent | Update the User Agent Restriction |
 
 
 ## create_playback_restriction
@@ -365,3 +366,75 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## update_user_agent_restriction
+
+> <PlaybackRestrictionResponse> update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
+
+Update the User Agent Restriction
+
+Allows you to modify how Mux validates playback requests with different user agents.  Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.
+
+### 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::PlaybackRestrictionsApi.new
+playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
+update_user_agent_restriction_request = MuxRuby::UpdateUserAgentRestrictionRequest.new # UpdateUserAgentRestrictionRequest | 
+
+begin
+  # Update the User Agent Restriction
+  result = api_instance.update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction: #{e}"
+end
+```
+
+#### Using the update_user_agent_restriction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
+
+```ruby
+begin
+  # Update the User Agent Restriction
+  data, status_code, headers = api_instance.update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PlaybackRestrictionResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **playback_restriction_id** | **String** | ID of the Playback Restriction. |  |
+| **update_user_agent_restriction_request** | [**UpdateUserAgentRestrictionRequest**](UpdateUserAgentRestrictionRequest.md) |  |  |
+
+### Return type
+
+[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/UpdateLiveStreamNewAssetSettings.md b/docs/UpdateLiveStreamNewAssetSettings.md
@@ -0,0 +1,18 @@
+# MuxRuby::UpdateLiveStreamNewAssetSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mp4_support** | **String** | Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The &#x60;none&#x60; option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The &#x60;capped-1080p&#x60; option produces a single MP4 file, called &#x60;capped-1080p.mp4&#x60;, with the video resolution capped at 1080p. This option produces an &#x60;audio.m4a&#x60; file for an audio-only asset. * The &#x60;audio-only&#x60; option produces a single M4A file, called &#x60;audio.m4a&#x60; for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The &#x60;audio-only,capped-1080p&#x60; option produces both the &#x60;audio.m4a&#x60; and &#x60;capped-1080p.mp4&#x60; files. Only the &#x60;capped-1080p.mp4&#x60; file is produced for a video-only asset, while only the &#x60;audio.m4a&#x60; file is produced for an audio-only asset. * The &#x60;standard&#x60;(deprecated) option produces up to three MP4 files with different levels of resolution (&#x60;high.mp4&#x60;, &#x60;medium.mp4&#x60;, &#x60;low.mp4&#x60;, or &#x60;audio.m4a&#x60; for an audio-only asset).  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
+  mp4_support: null
+)
+```
+
diff --git a/docs/UpdateLiveStreamRequest.md b/docs/UpdateLiveStreamRequest.md
@@ -10,6 +10,7 @@
 | **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. Set this to a blank string to clear the value so that the default slate media will be used. | [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] |
+| **new_asset_settings** | [**UpdateLiveStreamNewAssetSettings**](UpdateLiveStreamNewAssetSettings.md) |  | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = MuxRuby::UpdateLiveStreamRequest.new(
   reconnect_window: null,
   use_slate_for_standard_latency: null,
   reconnect_slate_url: null,
-  max_continuous_duration: null
+  max_continuous_duration: null,
+  new_asset_settings: null
 )
 ```
 
diff --git a/docs/UpdateUserAgentRestrictionRequest.md b/docs/UpdateUserAgentRestrictionRequest.md
@@ -0,0 +1,20 @@
+# MuxRuby::UpdateUserAgentRestrictionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
+| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::UpdateUserAgentRestrictionRequest.new(
+  allow_no_user_agent: null,
+  allow_high_risk_user_agent: null
+)
+```
+
diff --git a/docs/UserAgentRestrictionRequest.md b/docs/UserAgentRestrictionRequest.md
@@ -0,0 +1,20 @@
+# MuxRuby::UserAgentRestrictionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
+| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::UserAgentRestrictionRequest.new(
+  allow_no_user_agent: null,
+  allow_high_risk_user_agent: null
+)
+```
+
diff --git a/docs/UserAgentRestrictionSettings.md b/docs/UserAgentRestrictionSettings.md
@@ -0,0 +1,20 @@
+# MuxRuby::UserAgentRestrictionSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
+| **allow_high_risk_user_agent** | **Boolean** | Whether or not to allow high risk user agents. The high risk user agents are defined by Mux. | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::UserAgentRestrictionSettings.new(
+  allow_no_user_agent: null,
+  allow_high_risk_user_agent: null
+)
+```
+
diff --git a/docs/VideoView.md b/docs/VideoView.md
@@ -161,6 +161,12 @@
 | **playback_failure_error_type_id** | **Integer** |  | [optional] |
 | **playback_business_exception_error_type_id** | **Integer** |  | [optional] |
 | **video_startup_business_exception_error_type_id** | **Integer** |  | [optional] |
+| **playback_failure** | **Boolean** |  | [optional] |
+| **ad_playback_failure_error_type_id** | **Integer** |  | [optional] |
+| **view_content_startup_time** | **Integer** |  | [optional] |
+| **ad_preroll_startup_time** | **Integer** |  | [optional] |
+| **ad_watch_time** | **Integer** |  | [optional] |
+| **view_content_watch_time** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -324,7 +330,13 @@ instance = MuxRuby::VideoView.new(
   long_rebuffering: null,
   playback_failure_error_type_id: null,
   playback_business_exception_error_type_id: null,
-  video_startup_business_exception_error_type_id: null
+  video_startup_business_exception_error_type_id: null,
+  playback_failure: null,
+  ad_playback_failure_error_type_id: null,
+  view_content_startup_time: null,
+  ad_preroll_startup_time: null,
+  ad_watch_time: null,
+  view_content_watch_time: null
 )
 ```
 
diff --git a/gen/generator-config.json b/gen/generator-config.json
@@ -8,5 +8,5 @@
   "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
   "gemLicense": "MIT",
   "moduleName": "MuxRuby",
-  "gemVersion": "3.15.0"
+  "gemVersion": "3.16.0"
 }
diff --git a/lib/mux_ruby.rb b/lib/mux_ruby.rb
@@ -162,13 +162,17 @@
 require 'mux_ruby/models/update_asset_request'
 require 'mux_ruby/models/update_live_stream_embedded_subtitles_request'
 require 'mux_ruby/models/update_live_stream_generated_subtitles_request'
+require 'mux_ruby/models/update_live_stream_new_asset_settings'
 require 'mux_ruby/models/update_live_stream_request'
 require 'mux_ruby/models/update_referrer_domain_restriction_request'
 require 'mux_ruby/models/update_transcription_vocabulary_request'
+require 'mux_ruby/models/update_user_agent_restriction_request'
 require 'mux_ruby/models/update_web_input_url_request'
 require 'mux_ruby/models/upload'
 require 'mux_ruby/models/upload_error'
 require 'mux_ruby/models/upload_response'
+require 'mux_ruby/models/user_agent_restriction_request'
+require 'mux_ruby/models/user_agent_restriction_settings'
 require 'mux_ruby/models/video_view'
 require 'mux_ruby/models/video_view_event'
 require 'mux_ruby/models/video_view_response'