Skip to content

Commit 14f52d8

Browse files
jsanford8jsanford8
authored
v3.16.0 (#80)
1 parent b5a9876 commit 14f52d8

35 files changed

+1538
-43
lines changed

‎.openapi-generator/FILES

+12
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,17 @@ docs/UpdateAssetMasterAccessRequest.md
167167
docs/UpdateAssetRequest.md
168168
docs/UpdateLiveStreamEmbeddedSubtitlesRequest.md
169169
docs/UpdateLiveStreamGeneratedSubtitlesRequest.md
170+
docs/UpdateLiveStreamNewAssetSettings.md
170171
docs/UpdateLiveStreamRequest.md
171172
docs/UpdateReferrerDomainRestrictionRequest.md
172173
docs/UpdateTranscriptionVocabularyRequest.md
174+
docs/UpdateUserAgentRestrictionRequest.md
173175
docs/UpdateWebInputUrlRequest.md
174176
docs/Upload.md
175177
docs/UploadError.md
176178
docs/UploadResponse.md
179+
docs/UserAgentRestrictionRequest.md
180+
docs/UserAgentRestrictionSettings.md
177181
docs/VideoView.md
178182
docs/VideoViewEvent.md
179183
docs/VideoViewResponse.md
@@ -351,13 +355,17 @@ lib/mux_ruby/models/update_asset_mp4_support_request.rb
351355
lib/mux_ruby/models/update_asset_request.rb
352356
lib/mux_ruby/models/update_live_stream_embedded_subtitles_request.rb
353357
lib/mux_ruby/models/update_live_stream_generated_subtitles_request.rb
358+
lib/mux_ruby/models/update_live_stream_new_asset_settings.rb
354359
lib/mux_ruby/models/update_live_stream_request.rb
355360
lib/mux_ruby/models/update_referrer_domain_restriction_request.rb
356361
lib/mux_ruby/models/update_transcription_vocabulary_request.rb
362+
lib/mux_ruby/models/update_user_agent_restriction_request.rb
357363
lib/mux_ruby/models/update_web_input_url_request.rb
358364
lib/mux_ruby/models/upload.rb
359365
lib/mux_ruby/models/upload_error.rb
360366
lib/mux_ruby/models/upload_response.rb
367+
lib/mux_ruby/models/user_agent_restriction_request.rb
368+
lib/mux_ruby/models/user_agent_restriction_settings.rb
361369
lib/mux_ruby/models/video_view.rb
362370
lib/mux_ruby/models/video_view_event.rb
363371
lib/mux_ruby/models/video_view_response.rb
@@ -367,4 +375,8 @@ lib/mux_ruby/version.rb
367375
mux_ruby.gemspec
368376
spec/api_client_spec.rb
369377
spec/configuration_spec.rb
378+
spec/models/update_live_stream_new_asset_settings_spec.rb
379+
spec/models/update_user_agent_restriction_request_spec.rb
380+
spec/models/user_agent_restriction_request_spec.rb
381+
spec/models/user_agent_restriction_settings_spec.rb
370382
spec/spec_helper.rb

‎Gemfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
mux_ruby (3.15.0)
4+
mux_ruby (3.16.0)
55
typhoeus (~> 1.0, >= 1.0.1)
66

77
GEM

‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
2323
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
2424

2525
- API version: v1
26-
- Package version: 3.15.0
26+
- Package version: 3.16.0
2727
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
2828
For more information, please visit [https://docs.mux.com](https://docs.mux.com)
2929

@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
4040
Then either install the gem locally:
4141

4242
```shell
43-
gem install ./mux_ruby-3.15.0.gem
43+
gem install ./mux_ruby-3.16.0.gem
4444
```
4545

46-
(for development, run `gem install --dev ./mux_ruby-3.15.0.gem` to install the development dependencies)
46+
(for development, run `gem install --dev ./mux_ruby-3.16.0.gem` to install the development dependencies)
4747

4848
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
4949

5050
Finally add this to the Gemfile:
5151

52-
gem 'mux_ruby', '~> 3.15.0'
52+
gem 'mux_ruby', '~> 3.16.0'
5353

5454
### Install from Git
5555

‎docs/AbridgedVideoView.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
| **view_end** | **String** | | [optional] |
1818
| **viewer_experience_score** | **Float** | | [optional] |
1919
| **watch_time** | **Integer** | | [optional] |
20+
| **playback_failure** | **Boolean** | | [optional] |
2021

2122
## Example
2223

@@ -36,7 +37,8 @@ instance = MuxRuby::AbridgedVideoView.new(
3637
view_start: null,
3738
view_end: null,
3839
viewer_experience_score: null,
39-
watch_time: null
40+
watch_time: null,
41+
playback_failure: null
4042
)
4143
```
4244

‎docs/CreatePlaybackRestrictionRequest.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
8+
| **user_agent** | [**UserAgentRestrictionRequest**](UserAgentRestrictionRequest.md) | | [optional] |
89

910
## Example
1011

1112
```ruby
1213
require 'mux_ruby'
1314

1415
instance = MuxRuby::CreatePlaybackRestrictionRequest.new(
15-
referrer: null
16+
referrer: null,
17+
user_agent: null
1618
)
1719
```
1820

‎docs/DeliveryReport.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
| **asset_state** | **String** | The state of the asset. | [optional] |
1313
| **asset_duration** | **Float** | The duration of the asset in seconds. | [optional] |
1414
| **asset_resolution_tier** | **String** | The resolution tier that the asset was ingested at, affecting billing for ingest & storage | [optional] |
15+
| **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] |
1516
| **delivered_seconds** | **Float** | Total number of delivered seconds during this time window. | [optional] |
1617
| **delivered_seconds_by_resolution** | [**DeliveryReportDeliveredSecondsByResolution**](DeliveryReportDeliveredSecondsByResolution.md) | | [optional] |
1718

@@ -29,6 +30,7 @@ instance = MuxRuby::DeliveryReport.new(
2930
asset_state: null,
3031
asset_duration: null,
3132
asset_resolution_tier: null,
33+
asset_encoding_tier: null,
3234
delivered_seconds: null,
3335
delivered_seconds_by_resolution: null
3436
)

‎docs/GenerateTrackSubtitlesResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **data** | [**Track**](Track.md) | | [optional] |
7+
| **data** | [**Array<Track>**](Track.md) | | [optional] |
88

99
## Example
1010

‎docs/PlaybackRestriction.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
| **created_at** | **String** | Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
99
| **updated_at** | **String** | Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
1010
| **referrer** | [**ReferrerDomainRestriction**](ReferrerDomainRestriction.md) | | [optional] |
11+
| **user_agent** | [**UserAgentRestrictionSettings**](UserAgentRestrictionSettings.md) | | [optional] |
1112

1213
## Example
1314

@@ -18,7 +19,8 @@ instance = MuxRuby::PlaybackRestriction.new(
1819
id: null,
1920
created_at: null,
2021
updated_at: null,
21-
referrer: null
22+
referrer: null,
23+
user_agent: null
2224
)
2325
```
2426

‎docs/PlaybackRestrictionsApi.md

+73
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.mux.com*
99
| [**get_playback_restriction**](PlaybackRestrictionsApi.md#get_playback_restriction) | **GET** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID} | Retrieve a Playback Restriction |
1010
| [**list_playback_restrictions**](PlaybackRestrictionsApi.md#list_playback_restrictions) | **GET** /video/v1/playback-restrictions | List Playback Restrictions |
1111
| [**update_referrer_domain_restriction**](PlaybackRestrictionsApi.md#update_referrer_domain_restriction) | **PUT** /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer | Update the Referrer Playback Restriction |
12+
| [**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 |
1213

1314

1415
## create_playback_restriction
@@ -365,3 +366,75 @@ end
365366
- **Content-Type**: application/json
366367
- **Accept**: application/json
367368

369+
370+
## update_user_agent_restriction
371+
372+
> <PlaybackRestrictionResponse> update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
373+
374+
Update the User Agent Restriction
375+
376+
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.
377+
378+
### Examples
379+
380+
```ruby
381+
require 'time'
382+
require 'mux_ruby'
383+
# setup authorization
384+
MuxRuby.configure do |config|
385+
# Configure HTTP basic authorization: accessToken
386+
config.username = 'YOUR USERNAME'
387+
config.password = 'YOUR PASSWORD'
388+
end
389+
390+
api_instance = MuxRuby::PlaybackRestrictionsApi.new
391+
playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
392+
update_user_agent_restriction_request = MuxRuby::UpdateUserAgentRestrictionRequest.new # UpdateUserAgentRestrictionRequest |
393+
394+
begin
395+
# Update the User Agent Restriction
396+
result = api_instance.update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request)
397+
p result
398+
rescue MuxRuby::ApiError => e
399+
puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction: #{e}"
400+
end
401+
```
402+
403+
#### Using the update_user_agent_restriction_with_http_info variant
404+
405+
This returns an Array which contains the response data, status code and headers.
406+
407+
> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
408+
409+
```ruby
410+
begin
411+
# Update the User Agent Restriction
412+
data, status_code, headers = api_instance.update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request)
413+
p status_code # => 2xx
414+
p headers # => { ... }
415+
p data # => <PlaybackRestrictionResponse>
416+
rescue MuxRuby::ApiError => e
417+
puts "Error when calling PlaybackRestrictionsApi->update_user_agent_restriction_with_http_info: #{e}"
418+
end
419+
```
420+
421+
### Parameters
422+
423+
| Name | Type | Description | Notes |
424+
| ---- | ---- | ----------- | ----- |
425+
| **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
426+
| **update_user_agent_restriction_request** | [**UpdateUserAgentRestrictionRequest**](UpdateUserAgentRestrictionRequest.md) | | |
427+
428+
### Return type
429+
430+
[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
431+
432+
### Authorization
433+
434+
[accessToken](../README.md#accessToken)
435+
436+
### HTTP request headers
437+
438+
- **Content-Type**: application/json
439+
- **Accept**: application/json
440+

‎docs/UpdateLiveStreamNewAssetSettings.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MuxRuby::UpdateLiveStreamNewAssetSettings
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **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] |
8+
9+
## Example
10+
11+
```ruby
12+
require 'mux_ruby'
13+
14+
instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
15+
mp4_support: null
16+
)
17+
```
18+

‎docs/UpdateLiveStreamRequest.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
| **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] |
1111
| **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] |
1212
| **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] |
13+
| **new_asset_settings** | [**UpdateLiveStreamNewAssetSettings**](UpdateLiveStreamNewAssetSettings.md) | | [optional] |
1314

1415
## Example
1516

@@ -22,7 +23,8 @@ instance = MuxRuby::UpdateLiveStreamRequest.new(
2223
reconnect_window: null,
2324
use_slate_for_standard_latency: null,
2425
reconnect_slate_url: null,
25-
max_continuous_duration: null
26+
max_continuous_duration: null,
27+
new_asset_settings: null
2628
)
2729
```
2830

‎docs/UpdateUserAgentRestrictionRequest.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MuxRuby::UpdateUserAgentRestrictionRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
8+
| **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] |
9+
10+
## Example
11+
12+
```ruby
13+
require 'mux_ruby'
14+
15+
instance = MuxRuby::UpdateUserAgentRestrictionRequest.new(
16+
allow_no_user_agent: null,
17+
allow_high_risk_user_agent: null
18+
)
19+
```
20+

‎docs/UserAgentRestrictionRequest.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MuxRuby::UserAgentRestrictionRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
8+
| **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] |
9+
10+
## Example
11+
12+
```ruby
13+
require 'mux_ruby'
14+
15+
instance = MuxRuby::UserAgentRestrictionRequest.new(
16+
allow_no_user_agent: null,
17+
allow_high_risk_user_agent: null
18+
)
19+
```
20+

‎docs/UserAgentRestrictionSettings.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MuxRuby::UserAgentRestrictionSettings
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **allow_no_user_agent** | **Boolean** | Whether or not to allow views without a &#x60;User-Agent&#x60; HTTP request header. | [optional][default to true] |
8+
| **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] |
9+
10+
## Example
11+
12+
```ruby
13+
require 'mux_ruby'
14+
15+
instance = MuxRuby::UserAgentRestrictionSettings.new(
16+
allow_no_user_agent: null,
17+
allow_high_risk_user_agent: null
18+
)
19+
```
20+

‎docs/VideoView.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,12 @@
161161
| **playback_failure_error_type_id** | **Integer** | | [optional] |
162162
| **playback_business_exception_error_type_id** | **Integer** | | [optional] |
163163
| **video_startup_business_exception_error_type_id** | **Integer** | | [optional] |
164+
| **playback_failure** | **Boolean** | | [optional] |
165+
| **ad_playback_failure_error_type_id** | **Integer** | | [optional] |
166+
| **view_content_startup_time** | **Integer** | | [optional] |
167+
| **ad_preroll_startup_time** | **Integer** | | [optional] |
168+
| **ad_watch_time** | **Integer** | | [optional] |
169+
| **view_content_watch_time** | **Integer** | | [optional] |
164170

165171
## Example
166172

@@ -324,7 +330,13 @@ instance = MuxRuby::VideoView.new(
324330
long_rebuffering: null,
325331
playback_failure_error_type_id: null,
326332
playback_business_exception_error_type_id: null,
327-
video_startup_business_exception_error_type_id: null
333+
video_startup_business_exception_error_type_id: null,
334+
playback_failure: null,
335+
ad_playback_failure_error_type_id: null,
336+
view_content_startup_time: null,
337+
ad_preroll_startup_time: null,
338+
ad_watch_time: null,
339+
view_content_watch_time: null
328340
)
329341
```
330342

‎gen/generator-config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
"gemSourceLocation": "https://github.com/muxinc/mux-ruby",
99
"gemLicense": "MIT",
1010
"moduleName": "MuxRuby",
11-
"gemVersion": "3.15.0"
11+
"gemVersion": "3.16.0"
1212
}

‎lib/mux_ruby.rb

+4
Original file line numberDiff line numberDiff line change
@@ -162,13 +162,17 @@
162162
require 'mux_ruby/models/update_asset_request'
163163
require 'mux_ruby/models/update_live_stream_embedded_subtitles_request'
164164
require 'mux_ruby/models/update_live_stream_generated_subtitles_request'
165+
require 'mux_ruby/models/update_live_stream_new_asset_settings'
165166
require 'mux_ruby/models/update_live_stream_request'
166167
require 'mux_ruby/models/update_referrer_domain_restriction_request'
167168
require 'mux_ruby/models/update_transcription_vocabulary_request'
169+
require 'mux_ruby/models/update_user_agent_restriction_request'
168170
require 'mux_ruby/models/update_web_input_url_request'
169171
require 'mux_ruby/models/upload'
170172
require 'mux_ruby/models/upload_error'
171173
require 'mux_ruby/models/upload_response'
174+
require 'mux_ruby/models/user_agent_restriction_request'
175+
require 'mux_ruby/models/user_agent_restriction_settings'
172176
require 'mux_ruby/models/video_view'
173177
require 'mux_ruby/models/video_view_event'
174178
require 'mux_ruby/models/video_view_response'

0 commit comments

Comments
 (0)