mux_ruby 3.15.0 → 3.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +4 -4
- data/docs/AbridgedVideoView.md +3 -1
- data/docs/CreateAssetRequest.md +3 -1
- data/docs/CreateLiveStreamRequest.md +2 -0
- data/docs/CreatePlaybackIDRequest.md +3 -1
- data/docs/CreatePlaybackRestrictionRequest.md +3 -1
- data/docs/CreateUploadRequest.md +1 -1
- data/docs/DRMConfiguration.md +18 -0
- data/docs/DRMConfigurationResponse.md +18 -0
- data/docs/DRMConfigurationsApi.md +153 -0
- data/docs/DeliveryReport.md +2 -0
- data/docs/GenerateTrackSubtitlesResponse.md +1 -1
- data/docs/ListDRMConfigurationsResponse.md +18 -0
- data/docs/MetricsApi.md +8 -8
- data/docs/PlaybackID.md +3 -1
- data/docs/PlaybackRestriction.md +3 -1
- data/docs/PlaybackRestrictionsApi.md +73 -0
- data/docs/UpdateLiveStreamNewAssetSettings.md +18 -0
- data/docs/UpdateLiveStreamRequest.md +3 -1
- data/docs/UpdateUserAgentRestrictionRequest.md +20 -0
- data/docs/UserAgentRestrictionRequest.md +20 -0
- data/docs/UserAgentRestrictionSettings.md +20 -0
- data/docs/VideoView.md +13 -1
- data/gen/generator-config.json +1 -1
- data/lib/mux_ruby/api/drm_configurations_api.rb +148 -0
- data/lib/mux_ruby/api/metrics_api.rb +14 -14
- data/lib/mux_ruby/api/playback_restrictions_api.rb +71 -0
- data/lib/mux_ruby/models/abridged_video_view.rb +14 -5
- data/lib/mux_ruby/models/create_asset_request.rb +14 -2
- data/lib/mux_ruby/models/create_live_stream_request.rb +13 -1
- data/lib/mux_ruby/models/create_playback_id_request.rb +14 -4
- data/lib/mux_ruby/models/create_playback_restriction_request.rb +13 -4
- data/lib/mux_ruby/models/create_upload_request.rb +1 -0
- data/lib/mux_ruby/models/delivery_report.rb +23 -1
- data/lib/mux_ruby/models/drm_configuration.rb +219 -0
- data/lib/mux_ruby/models/drm_configuration_response.rb +218 -0
- data/lib/mux_ruby/models/generate_track_subtitles_response.rb +4 -2
- data/lib/mux_ruby/models/list_drm_configurations_response.rb +220 -0
- data/lib/mux_ruby/models/playback_id.rb +14 -4
- data/lib/mux_ruby/models/playback_policy.rb +1 -0
- data/lib/mux_ruby/models/playback_restriction.rb +13 -4
- data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb +254 -0
- data/lib/mux_ruby/models/update_live_stream_request.rb +13 -4
- data/lib/mux_ruby/models/update_user_agent_restriction_request.rb +233 -0
- data/lib/mux_ruby/models/user_agent_restriction_request.rb +234 -0
- data/lib/mux_ruby/models/user_agent_restriction_settings.rb +234 -0
- data/lib/mux_ruby/models/video_view.rb +66 -4
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +8 -0
- data/spec/api/drm_configurations_api_spec.rb +60 -0
- data/spec/models/drm_configuration_response_spec.rb +34 -0
- data/spec/models/drm_configuration_spec.rb +34 -0
- data/spec/models/list_drm_configurations_response_spec.rb +34 -0
- data/spec/models/update_live_stream_new_asset_settings_spec.rb +38 -0
- data/spec/models/update_user_agent_restriction_request_spec.rb +40 -0
- data/spec/models/user_agent_restriction_request_spec.rb +40 -0
- data/spec/models/user_agent_restriction_settings_spec.rb +40 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +18 -18
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +3 -3
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
- metadata +185 -153
@@ -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 `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` 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
|
+
|
@@ -10,6 +10,7 @@
|
|
10
10
|
| **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] |
|
11
11
|
| **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] |
|
12
12
|
| **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] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MuxRuby::UpdateLiveStreamRequest.new(
|
|
22
23
|
reconnect_window: null,
|
23
24
|
use_slate_for_standard_latency: null,
|
24
25
|
reconnect_slate_url: null,
|
25
|
-
max_continuous_duration: null
|
26
|
+
max_continuous_duration: null,
|
27
|
+
new_asset_settings: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
@@ -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 `User-Agent` 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
|
+
|
@@ -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 `User-Agent` 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
|
+
|
@@ -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 `User-Agent` 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
|
+
|
data/docs/VideoView.md
CHANGED
@@ -161,6 +161,12 @@
|
|
161
161
|
| **playback_failure_error_type_id** | **Integer** | | [optional] |
|
162
162
|
| **playback_business_exception_error_type_id** | **Integer** | | [optional] |
|
163
163
|
| **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] |
|
164
170
|
|
165
171
|
## Example
|
166
172
|
|
@@ -324,7 +330,13 @@ instance = MuxRuby::VideoView.new(
|
|
324
330
|
long_rebuffering: null,
|
325
331
|
playback_failure_error_type_id: null,
|
326
332
|
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
|
328
340
|
)
|
329
341
|
```
|
330
342
|
|
data/gen/generator-config.json
CHANGED
@@ -0,0 +1,148 @@
|
|
1
|
+
=begin
|
2
|
+
#Mux API
|
3
|
+
|
4
|
+
#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
Contact: devex@mux.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.0.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MuxRuby
|
16
|
+
class DRMConfigurationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Retrieve a DRM Configuration
|
23
|
+
# Retrieves a single DRM Configuration.
|
24
|
+
# @param drm_configuration_id [String] The DRM Configuration ID.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [DRMConfigurationResponse]
|
27
|
+
def get_drm_configuration(drm_configuration_id, opts = {})
|
28
|
+
data, _status_code, _headers = get_drm_configuration_with_http_info(drm_configuration_id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Retrieve a DRM Configuration
|
33
|
+
# Retrieves a single DRM Configuration.
|
34
|
+
# @param drm_configuration_id [String] The DRM Configuration ID.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(DRMConfigurationResponse, Integer, Hash)>] DRMConfigurationResponse data, response status code and response headers
|
37
|
+
def get_drm_configuration_with_http_info(drm_configuration_id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: DRMConfigurationsApi.get_drm_configuration ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'drm_configuration_id' is set
|
42
|
+
if @api_client.config.client_side_validation && drm_configuration_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'drm_configuration_id' when calling DRMConfigurationsApi.get_drm_configuration"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/video/v1/drm-configurations/{DRM_CONFIGURATION_ID}'.sub('{' + 'DRM_CONFIGURATION_ID' + '}', CGI.escape(drm_configuration_id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:debug_body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type] || 'DRMConfigurationResponse'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"DRMConfigurationsApi.get_drm_configuration",
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: DRMConfigurationsApi#get_drm_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# List DRM Configurations
|
86
|
+
# Returns a list of DRM Configurations
|
87
|
+
# @param [Hash] opts the optional parameters
|
88
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
89
|
+
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
90
|
+
# @return [ListDRMConfigurationsResponse]
|
91
|
+
def list_drm_configurations(opts = {})
|
92
|
+
data, _status_code, _headers = list_drm_configurations_with_http_info(opts)
|
93
|
+
data
|
94
|
+
end
|
95
|
+
|
96
|
+
# List DRM Configurations
|
97
|
+
# Returns a list of DRM Configurations
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
100
|
+
# @option opts [Integer] :limit Number of items to include in the response
|
101
|
+
# @return [Array<(ListDRMConfigurationsResponse, Integer, Hash)>] ListDRMConfigurationsResponse data, response status code and response headers
|
102
|
+
def list_drm_configurations_with_http_info(opts = {})
|
103
|
+
if @api_client.config.debugging
|
104
|
+
@api_client.config.logger.debug 'Calling API: DRMConfigurationsApi.list_drm_configurations ...'
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/video/v1/drm-configurations'
|
108
|
+
|
109
|
+
# query parameters
|
110
|
+
query_params = opts[:query_params] || {}
|
111
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
112
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
113
|
+
|
114
|
+
# header parameters
|
115
|
+
header_params = opts[:header_params] || {}
|
116
|
+
# HTTP header 'Accept' (if needed)
|
117
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
118
|
+
|
119
|
+
# form parameters
|
120
|
+
form_params = opts[:form_params] || {}
|
121
|
+
|
122
|
+
# http body (model)
|
123
|
+
post_body = opts[:debug_body]
|
124
|
+
|
125
|
+
# return_type
|
126
|
+
return_type = opts[:debug_return_type] || 'ListDRMConfigurationsResponse'
|
127
|
+
|
128
|
+
# auth_names
|
129
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
130
|
+
|
131
|
+
new_options = opts.merge(
|
132
|
+
:operation => :"DRMConfigurationsApi.list_drm_configurations",
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names,
|
138
|
+
:return_type => return_type
|
139
|
+
)
|
140
|
+
|
141
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
142
|
+
if @api_client.config.debugging
|
143
|
+
@api_client.config.logger.debug "API called: DRMConfigurationsApi#list_drm_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
144
|
+
end
|
145
|
+
return data, status_code, headers
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
@@ -26,7 +26,7 @@ module MuxRuby
|
|
26
26
|
# @option opts [Array<String>] :timeframe 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`
|
27
27
|
# @option opts [Array<String>] :filters 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`
|
28
28
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
29
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
29
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
30
30
|
# @option opts [String] :order_direction Sort order.
|
31
31
|
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
32
32
|
# @return [GetMetricTimeseriesDataResponse]
|
@@ -42,7 +42,7 @@ module MuxRuby
|
|
42
42
|
# @option opts [Array<String>] :timeframe 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`
|
43
43
|
# @option opts [Array<String>] :filters 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`
|
44
44
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
45
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
45
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
46
46
|
# @option opts [String] :order_direction Sort order.
|
47
47
|
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
48
48
|
# @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
|
@@ -55,7 +55,7 @@ module MuxRuby
|
|
55
55
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
|
56
56
|
end
|
57
57
|
# verify enum value
|
58
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage"]
|
58
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "ad_watch_time", "view_content_watch_time"]
|
59
59
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
60
60
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
61
61
|
end
|
@@ -124,7 +124,7 @@ module MuxRuby
|
|
124
124
|
# @option opts [Array<String>] :timeframe 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`
|
125
125
|
# @option opts [Array<String>] :filters 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`
|
126
126
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
127
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
127
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
128
128
|
# @return [GetOverallValuesResponse]
|
129
129
|
def get_overall_values(metric_id, opts = {})
|
130
130
|
data, _status_code, _headers = get_overall_values_with_http_info(metric_id, opts)
|
@@ -138,7 +138,7 @@ module MuxRuby
|
|
138
138
|
# @option opts [Array<String>] :timeframe 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`
|
139
139
|
# @option opts [Array<String>] :filters 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`
|
140
140
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
141
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
141
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
142
142
|
# @return [Array<(GetOverallValuesResponse, Integer, Hash)>] GetOverallValuesResponse data, response status code and response headers
|
143
143
|
def get_overall_values_with_http_info(metric_id, opts = {})
|
144
144
|
if @api_client.config.debugging
|
@@ -149,7 +149,7 @@ module MuxRuby
|
|
149
149
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
|
150
150
|
end
|
151
151
|
# verify enum value
|
152
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage"]
|
152
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "ad_watch_time", "view_content_watch_time"]
|
153
153
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
154
154
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
155
155
|
end
|
@@ -228,7 +228,7 @@ module MuxRuby
|
|
228
228
|
if @api_client.config.debugging
|
229
229
|
@api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
|
230
230
|
end
|
231
|
-
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
231
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure"]
|
232
232
|
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
233
233
|
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
234
234
|
end
|
@@ -282,7 +282,7 @@ module MuxRuby
|
|
282
282
|
# @param metric_id [String] ID of the Metric
|
283
283
|
# @param [Hash] opts the optional parameters
|
284
284
|
# @option opts [String] :group_by Breakdown value to group the results by
|
285
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
285
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
286
286
|
# @option opts [Array<String>] :filters 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`
|
287
287
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
288
288
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
@@ -301,7 +301,7 @@ module MuxRuby
|
|
301
301
|
# @param metric_id [String] ID of the Metric
|
302
302
|
# @param [Hash] opts the optional parameters
|
303
303
|
# @option opts [String] :group_by Breakdown value to group the results by
|
304
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
304
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
305
305
|
# @option opts [Array<String>] :filters 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`
|
306
306
|
# @option opts [Array<String>] :metric_filters Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
|
307
307
|
# @option opts [Integer] :limit Number of items to include in the response
|
@@ -319,11 +319,11 @@ module MuxRuby
|
|
319
319
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
|
320
320
|
end
|
321
321
|
# verify enum value
|
322
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage"]
|
322
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "ad_watch_time", "view_content_watch_time"]
|
323
323
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
324
324
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
325
325
|
end
|
326
|
-
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
326
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure"]
|
327
327
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
328
328
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
329
329
|
end
|
@@ -392,7 +392,7 @@ module MuxRuby
|
|
392
392
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
393
393
|
# @param metric_id [String] ID of the Metric
|
394
394
|
# @param [Hash] opts the optional parameters
|
395
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
395
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
396
396
|
# @option opts [String] :order_direction Sort order.
|
397
397
|
# @option opts [Array<String>] :timeframe 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`
|
398
398
|
# @option opts [Array<String>] :filters 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`
|
@@ -407,7 +407,7 @@ module MuxRuby
|
|
407
407
|
# Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
|
408
408
|
# @param metric_id [String] ID of the Metric
|
409
409
|
# @param [Hash] opts the optional parameters
|
410
|
-
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
410
|
+
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used. The default measurement for each metric is: \"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time` \"median\" : `ad_preroll_startup_time`, `ad_watch_time`, `aggregate_startup_time`, `content_startup_time`, `content_watch_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate` \"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `viewer_experience_score` \"count\" : `started_views`, `unique_viewers`
|
411
411
|
# @option opts [String] :order_direction Sort order.
|
412
412
|
# @option opts [Array<String>] :timeframe 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`
|
413
413
|
# @option opts [Array<String>] :filters 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`
|
@@ -422,7 +422,7 @@ module MuxRuby
|
|
422
422
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
|
423
423
|
end
|
424
424
|
# verify enum value
|
425
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage"]
|
425
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "ad_watch_time", "view_content_watch_time"]
|
426
426
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
427
427
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
428
428
|
end
|
@@ -341,5 +341,76 @@ module MuxRuby
|
|
341
341
|
end
|
342
342
|
return data, status_code, headers
|
343
343
|
end
|
344
|
+
|
345
|
+
# Update the User Agent Restriction
|
346
|
+
# 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.
|
347
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
348
|
+
# @param update_user_agent_restriction_request [UpdateUserAgentRestrictionRequest]
|
349
|
+
# @param [Hash] opts the optional parameters
|
350
|
+
# @return [PlaybackRestrictionResponse]
|
351
|
+
def update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request, opts = {})
|
352
|
+
data, _status_code, _headers = update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts)
|
353
|
+
data
|
354
|
+
end
|
355
|
+
|
356
|
+
# Update the User Agent Restriction
|
357
|
+
# 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.
|
358
|
+
# @param playback_restriction_id [String] ID of the Playback Restriction.
|
359
|
+
# @param update_user_agent_restriction_request [UpdateUserAgentRestrictionRequest]
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @return [Array<(PlaybackRestrictionResponse, Integer, Hash)>] PlaybackRestrictionResponse data, response status code and response headers
|
362
|
+
def update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts = {})
|
363
|
+
if @api_client.config.debugging
|
364
|
+
@api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_user_agent_restriction ...'
|
365
|
+
end
|
366
|
+
# verify the required parameter 'playback_restriction_id' is set
|
367
|
+
if @api_client.config.client_side_validation && playback_restriction_id.nil?
|
368
|
+
fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
|
369
|
+
end
|
370
|
+
# verify the required parameter 'update_user_agent_restriction_request' is set
|
371
|
+
if @api_client.config.client_side_validation && update_user_agent_restriction_request.nil?
|
372
|
+
fail ArgumentError, "Missing the required parameter 'update_user_agent_restriction_request' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
|
373
|
+
end
|
374
|
+
# resource path
|
375
|
+
local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))
|
376
|
+
|
377
|
+
# query parameters
|
378
|
+
query_params = opts[:query_params] || {}
|
379
|
+
|
380
|
+
# header parameters
|
381
|
+
header_params = opts[:header_params] || {}
|
382
|
+
# HTTP header 'Accept' (if needed)
|
383
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
384
|
+
# HTTP header 'Content-Type'
|
385
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
386
|
+
|
387
|
+
# form parameters
|
388
|
+
form_params = opts[:form_params] || {}
|
389
|
+
|
390
|
+
# http body (model)
|
391
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_user_agent_restriction_request)
|
392
|
+
|
393
|
+
# return_type
|
394
|
+
return_type = opts[:debug_return_type] || 'PlaybackRestrictionResponse'
|
395
|
+
|
396
|
+
# auth_names
|
397
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
398
|
+
|
399
|
+
new_options = opts.merge(
|
400
|
+
:operation => :"PlaybackRestrictionsApi.update_user_agent_restriction",
|
401
|
+
:header_params => header_params,
|
402
|
+
:query_params => query_params,
|
403
|
+
:form_params => form_params,
|
404
|
+
:body => post_body,
|
405
|
+
:auth_names => auth_names,
|
406
|
+
:return_type => return_type
|
407
|
+
)
|
408
|
+
|
409
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
410
|
+
if @api_client.config.debugging
|
411
|
+
@api_client.config.logger.debug "API called: PlaybackRestrictionsApi#update_user_agent_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
412
|
+
end
|
413
|
+
return data, status_code, headers
|
414
|
+
end
|
344
415
|
end
|
345
416
|
end
|