mux_ruby 3.12.0 → 3.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +4 -4
  4. data/docs/AbridgedVideoView.md +5 -1
  5. data/docs/Asset.md +3 -1
  6. data/docs/AssetsApi.md +79 -4
  7. data/docs/CreateSimulcastTargetRequest.md +2 -2
  8. data/docs/DimensionsApi.md +2 -0
  9. data/docs/Error.md +3 -1
  10. data/docs/ErrorsApi.md +2 -0
  11. data/docs/GenerateTrackSubtitlesRequest.md +18 -0
  12. data/docs/GenerateTrackSubtitlesResponse.md +18 -0
  13. data/docs/InputSettings.md +2 -2
  14. data/docs/LiveStream.md +5 -1
  15. data/docs/LiveStreamsApi.md +8 -8
  16. data/docs/MetricsApi.md +13 -1
  17. data/docs/MonitoringBreakdownTimeseriesDatapoint.md +3 -1
  18. data/docs/PlaybackIDApi.md +4 -4
  19. data/docs/ReferrerDomainRestriction.md +1 -1
  20. data/docs/SimulcastTarget.md +6 -4
  21. data/docs/Track.md +3 -1
  22. data/docs/VideoView.md +30 -2
  23. data/docs/VideoViewsApi.md +2 -0
  24. data/gen/generator-config.json +1 -1
  25. data/lib/mux_ruby/api/assets_api.rb +79 -2
  26. data/lib/mux_ruby/api/dimensions_api.rb +3 -0
  27. data/lib/mux_ruby/api/errors_api.rb +3 -0
  28. data/lib/mux_ruby/api/live_streams_api.rb +4 -4
  29. data/lib/mux_ruby/api/metrics_api.rb +24 -6
  30. data/lib/mux_ruby/api/playback_id_api.rb +2 -2
  31. data/lib/mux_ruby/api/video_views_api.rb +3 -0
  32. data/lib/mux_ruby/models/abridged_video_view.rb +24 -4
  33. data/lib/mux_ruby/models/asset.rb +26 -4
  34. data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +2 -2
  35. data/lib/mux_ruby/models/create_simulcast_target_request.rb +2 -2
  36. data/lib/mux_ruby/models/error.rb +16 -5
  37. data/lib/mux_ruby/models/generate_track_subtitles_request.rb +221 -0
  38. data/lib/mux_ruby/models/generate_track_subtitles_response.rb +218 -0
  39. data/lib/mux_ruby/models/input_settings.rb +2 -2
  40. data/lib/mux_ruby/models/live_stream.rb +36 -4
  41. data/lib/mux_ruby/models/monitoring_breakdown_timeseries_datapoint.rb +13 -4
  42. data/lib/mux_ruby/models/referrer_domain_restriction.rb +1 -1
  43. data/lib/mux_ruby/models/simulcast_target.rb +29 -7
  44. data/lib/mux_ruby/models/track.rb +14 -4
  45. data/lib/mux_ruby/models/video_view.rb +142 -5
  46. data/lib/mux_ruby/version.rb +1 -1
  47. data/lib/mux_ruby.rb +2 -0
  48. data/spec/models/generate_track_subtitles_request_spec.rb +34 -0
  49. data/spec/models/generate_track_subtitles_response_spec.rb +34 -0
  50. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  51. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
  52. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
  53. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
  54. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +16 -16
  55. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
  56. 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
  57. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
  58. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
  59. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
  60. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
  61. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
  62. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
  63. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +6 -6
  64. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  65. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +6 -6
  66. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
  67. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +6 -6
  68. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  69. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +6 -6
  70. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
  71. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +6 -6
  72. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
  73. data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
  74. data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
  75. data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
  76. data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
  77. data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
  78. data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.16.3.gemspec +2 -2
  79. data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
  80. data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
  81. data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.22.1.gemspec +2 -2
  82. data/vendor/bundle/ruby/3.2.0/specifications/parser-3.1.2.0.gemspec +2 -2
  83. data/vendor/bundle/ruby/3.2.0/specifications/pry-0.13.1.gemspec +2 -2
  84. data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.9.0.gemspec +2 -2
  85. data/vendor/bundle/ruby/3.2.0/specifications/psych-4.0.4.gemspec +2 -2
  86. data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
  87. data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
  88. data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.11.0.gemspec +2 -2
  89. data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.11.0.gemspec +2 -2
  90. data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.11.0.gemspec +2 -2
  91. data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.11.1.gemspec +2 -2
  92. data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.11.0.gemspec +2 -2
  93. data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
  94. data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.11.0.gemspec +2 -2
  95. data/vendor/bundle/ruby/3.2.0/specifications/solid_assert-1.1.0.gemspec +2 -2
  96. data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.2.gemspec +2 -2
  97. data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.1.gemspec +2 -2
  98. data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
  99. metadata +160 -152
@@ -6,9 +6,10 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | ID of the Simulcast Target | [optional] |
8
8
  | **passthrough** | **String** | Arbitrary user-supplied metadata set when creating a simulcast target. | [optional] |
9
- | **status** | **String** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional] |
10
- | **stream_key** | **String** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] |
11
- | **url** | **String** | RTMP hostname including the application name for the third party live streaming service. | [optional] |
9
+ | **status** | **String** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. When a simulcast target has this status it will have an `error_severity` field with more details about the error. | [optional] |
10
+ | **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations. | [optional] |
11
+ | **url** | **String** | The RTMP(s) or SRT endpoint for a simulcast destination. * For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`. * For SRT destinations, this should be a fully formed SRT connection string, for example: `srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}`. Note: SRT simulcast targets can only be used when an source is connected over SRT. | [optional] |
12
+ | **error_severity** | **String** | The severity of the error encountered by the simulcast target. This field is only set when the simulcast target is in the `errored` status. See the values of severities below and their descriptions. * `normal`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. A simulcast may transition back into the broadcasting state if a connection with the service can be re-established. * `fatal`: The simulcast target is incompatible with the current input to the parent live stream. No further attempts to this simulcast target will be made for the current live stream asset. | [optional] |
12
13
 
13
14
  ## Example
14
15
 
@@ -20,7 +21,8 @@ instance = MuxRuby::SimulcastTarget.new(
20
21
  passthrough: null,
21
22
  status: null,
22
23
  stream_key: null,
23
- url: null
24
+ url: null,
25
+ error_severity: null
24
26
  )
25
27
  ```
26
28
 
data/docs/Track.md CHANGED
@@ -19,6 +19,7 @@
19
19
  | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set tracks where `type` is `text` and `text_type` is `subtitles`. | [optional] |
20
20
  | **passthrough** | **String** | Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for `text` type tracks. Max 255 characters. | [optional] |
21
21
  | **status** | **String** | The status of the track. This parameter is only set for `text` type tracks. | [optional] |
22
+ | **primary** | **Boolean** | For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted. | [optional] |
22
23
 
23
24
  ## Example
24
25
 
@@ -40,7 +41,8 @@ instance = MuxRuby::Track.new(
40
41
  name: null,
41
42
  closed_captions: null,
42
43
  passthrough: null,
43
- status: null
44
+ status: null,
45
+ primary: null
44
46
  )
45
47
  ```
46
48
 
data/docs/VideoView.md CHANGED
@@ -123,7 +123,7 @@
123
123
  | **view_session_id** | **String** | | [optional] |
124
124
  | **viewer_connection_type** | **String** | | [optional] |
125
125
  | **viewer_device_model** | **String** | | [optional] |
126
- | **weighted_average_bitrate** | **Integer** | | [optional] |
126
+ | **weighted_average_bitrate** | **Float** | | [optional] |
127
127
  | **custom_1** | **String** | | [optional] |
128
128
  | **custom_2** | **String** | | [optional] |
129
129
  | **custom_3** | **String** | | [optional] |
@@ -145,8 +145,22 @@
145
145
  | **view_dropped_frame_count** | **Integer** | | [optional] |
146
146
  | **view_has_ad** | **Boolean** | | [optional] |
147
147
  | **video_startup_failure** | **Boolean** | | [optional] |
148
+ | **ad_attempt_count** | **Integer** | | [optional] |
149
+ | **ad_break_count** | **Integer** | | [optional] |
150
+ | **ad_break_error_count** | **Integer** | | [optional] |
151
+ | **ad_break_error_percentage** | **String** | | [optional] |
152
+ | **ad_error_count** | **Integer** | | [optional] |
153
+ | **ad_error_percentage** | **String** | | [optional] |
154
+ | **ad_impression_count** | **Integer** | | [optional] |
155
+ | **ad_startup_error_count** | **Integer** | | [optional] |
156
+ | **ad_startup_error_percentage** | **String** | | [optional] |
157
+ | **ad_exit_before_start_count** | **Integer** | | [optional] |
158
+ | **ad_exit_before_start_percentage** | **String** | | [optional] |
148
159
  | **long_resume** | **Boolean** | | [optional] |
149
160
  | **long_rebuffering** | **Boolean** | | [optional] |
161
+ | **playback_failure_error_type_id** | **Integer** | | [optional] |
162
+ | **playback_business_exception_error_type_id** | **Integer** | | [optional] |
163
+ | **video_startup_business_exception_error_type_id** | **Integer** | | [optional] |
150
164
 
151
165
  ## Example
152
166
 
@@ -295,8 +309,22 @@ instance = MuxRuby::VideoView.new(
295
309
  view_dropped_frame_count: null,
296
310
  view_has_ad: null,
297
311
  video_startup_failure: null,
312
+ ad_attempt_count: null,
313
+ ad_break_count: null,
314
+ ad_break_error_count: null,
315
+ ad_break_error_percentage: null,
316
+ ad_error_count: null,
317
+ ad_error_percentage: null,
318
+ ad_impression_count: null,
319
+ ad_startup_error_count: null,
320
+ ad_startup_error_percentage: null,
321
+ ad_exit_before_start_count: null,
322
+ ad_exit_before_start_percentage: null,
298
323
  long_resume: null,
299
- long_rebuffering: null
324
+ long_rebuffering: null,
325
+ playback_failure_error_type_id: null,
326
+ playback_business_exception_error_type_id: null,
327
+ video_startup_business_exception_error_type_id: null
300
328
  )
301
329
  ```
302
330
 
@@ -106,6 +106,7 @@ opts = {
106
106
  error_id: 56, # Integer | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
107
107
  order_direction: 'asc', # String | Sort order.
108
108
  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
109
+ metric_filters: ['inner_example'], # Array<String> | 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`
109
110
  timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
110
111
  }
111
112
 
@@ -146,6 +147,7 @@ end
146
147
  | **error_id** | **Integer** | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] |
147
148
  | **order_direction** | **String** | Sort order. | [optional] |
148
149
  | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
150
+ | **metric_filters** | [**Array&lt;String&gt;**](String.md) | 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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional] |
149
151
  | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional] |
150
152
 
151
153
  ### Return type
@@ -8,5 +8,5 @@
8
8
  "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
9
9
  "gemLicense": "MIT",
10
10
  "moduleName": "MuxRuby",
11
- "gemVersion": "3.12.0"
11
+ "gemVersion": "3.14.0"
12
12
  }
@@ -421,6 +421,83 @@ module MuxRuby
421
421
  return data, status_code, headers
422
422
  end
423
423
 
424
+ # Generate track subtitles
425
+ # Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created.
426
+ # @param asset_id [String] The asset ID.
427
+ # @param track_id [String] The track ID.
428
+ # @param generate_track_subtitles_request [GenerateTrackSubtitlesRequest]
429
+ # @param [Hash] opts the optional parameters
430
+ # @return [GenerateTrackSubtitlesResponse]
431
+ def generate_asset_track_subtitles(asset_id, track_id, generate_track_subtitles_request, opts = {})
432
+ data, _status_code, _headers = generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request, opts)
433
+ data
434
+ end
435
+
436
+ # Generate track subtitles
437
+ # Generates subtitles (captions) for a given audio track. This API can be used for up to 7 days after an asset is created.
438
+ # @param asset_id [String] The asset ID.
439
+ # @param track_id [String] The track ID.
440
+ # @param generate_track_subtitles_request [GenerateTrackSubtitlesRequest]
441
+ # @param [Hash] opts the optional parameters
442
+ # @return [Array<(GenerateTrackSubtitlesResponse, Integer, Hash)>] GenerateTrackSubtitlesResponse data, response status code and response headers
443
+ def generate_asset_track_subtitles_with_http_info(asset_id, track_id, generate_track_subtitles_request, opts = {})
444
+ if @api_client.config.debugging
445
+ @api_client.config.logger.debug 'Calling API: AssetsApi.generate_asset_track_subtitles ...'
446
+ end
447
+ # verify the required parameter 'asset_id' is set
448
+ if @api_client.config.client_side_validation && asset_id.nil?
449
+ fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.generate_asset_track_subtitles"
450
+ end
451
+ # verify the required parameter 'track_id' is set
452
+ if @api_client.config.client_side_validation && track_id.nil?
453
+ fail ArgumentError, "Missing the required parameter 'track_id' when calling AssetsApi.generate_asset_track_subtitles"
454
+ end
455
+ # verify the required parameter 'generate_track_subtitles_request' is set
456
+ if @api_client.config.client_side_validation && generate_track_subtitles_request.nil?
457
+ fail ArgumentError, "Missing the required parameter 'generate_track_subtitles_request' when calling AssetsApi.generate_asset_track_subtitles"
458
+ end
459
+ # resource path
460
+ local_var_path = '/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'TRACK_ID' + '}', CGI.escape(track_id.to_s))
461
+
462
+ # query parameters
463
+ query_params = opts[:query_params] || {}
464
+
465
+ # header parameters
466
+ header_params = opts[:header_params] || {}
467
+ # HTTP header 'Accept' (if needed)
468
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
469
+ # HTTP header 'Content-Type'
470
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
471
+
472
+ # form parameters
473
+ form_params = opts[:form_params] || {}
474
+
475
+ # http body (model)
476
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(generate_track_subtitles_request)
477
+
478
+ # return_type
479
+ return_type = opts[:debug_return_type] || 'GenerateTrackSubtitlesResponse'
480
+
481
+ # auth_names
482
+ auth_names = opts[:debug_auth_names] || ['accessToken']
483
+
484
+ new_options = opts.merge(
485
+ :operation => :"AssetsApi.generate_asset_track_subtitles",
486
+ :header_params => header_params,
487
+ :query_params => query_params,
488
+ :form_params => form_params,
489
+ :body => post_body,
490
+ :auth_names => auth_names,
491
+ :return_type => return_type
492
+ )
493
+
494
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
495
+ if @api_client.config.debugging
496
+ @api_client.config.logger.debug "API called: AssetsApi#generate_asset_track_subtitles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
497
+ end
498
+ return data, status_code, headers
499
+ end
500
+
424
501
  # Retrieve an asset
425
502
  # Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.
426
503
  # @param asset_id [String] The asset ID.
@@ -685,7 +762,7 @@ module MuxRuby
685
762
  return data, status_code, headers
686
763
  end
687
764
 
688
- # Update an Asset
765
+ # Update an asset
689
766
  # Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.
690
767
  # @param asset_id [String] The asset ID.
691
768
  # @param update_asset_request [UpdateAssetRequest]
@@ -696,7 +773,7 @@ module MuxRuby
696
773
  data
697
774
  end
698
775
 
699
- # Update an Asset
776
+ # Update an asset
700
777
  # Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the &#x60;passthrough&#x60; field.
701
778
  # @param asset_id [String] The asset ID.
702
779
  # @param update_asset_request [UpdateAssetRequest]
@@ -26,6 +26,7 @@ module MuxRuby
26
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
27
27
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
28
28
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
29
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
29
30
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
30
31
  # @return [ListDimensionValuesResponse]
31
32
  def list_dimension_values(dimension_id, opts = {})
@@ -40,6 +41,7 @@ module MuxRuby
40
41
  # @option opts [Integer] :limit Number of items to include in the response
41
42
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
42
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
43
45
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
44
46
  # @return [Array<(ListDimensionValuesResponse, Integer, Hash)>] ListDimensionValuesResponse data, response status code and response headers
45
47
  def list_dimension_values_with_http_info(dimension_id, opts = {})
@@ -58,6 +60,7 @@ module MuxRuby
58
60
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
59
61
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
60
62
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
63
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
61
64
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
62
65
 
63
66
  # header parameters
@@ -23,6 +23,7 @@ module MuxRuby
23
23
  # Returns a list of errors.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
26
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
26
27
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
27
28
  # @return [ListErrorsResponse]
28
29
  def list_errors(opts = {})
@@ -34,6 +35,7 @@ module MuxRuby
34
35
  # Returns a list of errors.
35
36
  # @param [Hash] opts the optional parameters
36
37
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
38
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
37
39
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
38
40
  # @return [Array<(ListErrorsResponse, Integer, Hash)>] ListErrorsResponse data, response status code and response headers
39
41
  def list_errors_with_http_info(opts = {})
@@ -46,6 +48,7 @@ module MuxRuby
46
48
  # query parameters
47
49
  query_params = opts[:query_params] || {}
48
50
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
51
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
49
52
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
50
53
 
51
54
  # header parameters
@@ -354,7 +354,7 @@ module MuxRuby
354
354
  return data, status_code, headers
355
355
  end
356
356
 
357
- # Delete a Live Stream Simulcast Target
357
+ # Delete a live stream simulcast target
358
358
  # Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
359
359
  # @param live_stream_id [String] The live stream ID
360
360
  # @param simulcast_target_id [String] The ID of the simulcast target.
@@ -365,7 +365,7 @@ module MuxRuby
365
365
  nil
366
366
  end
367
367
 
368
- # Delete a Live Stream Simulcast Target
368
+ # Delete a live stream simulcast target
369
369
  # Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
370
370
  # @param live_stream_id [String] The live stream ID
371
371
  # @param simulcast_target_id [String] The ID of the simulcast target.
@@ -679,7 +679,7 @@ module MuxRuby
679
679
  return data, status_code, headers
680
680
  end
681
681
 
682
- # Retrieve a Live Stream Simulcast Target
682
+ # Retrieve a live stream simulcast target
683
683
  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
684
684
  # @param live_stream_id [String] The live stream ID
685
685
  # @param simulcast_target_id [String] The ID of the simulcast target.
@@ -690,7 +690,7 @@ module MuxRuby
690
690
  data
691
691
  end
692
692
 
693
- # Retrieve a Live Stream Simulcast Target
693
+ # Retrieve a live stream simulcast target
694
694
  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
695
695
  # @param live_stream_id [String] The live stream ID
696
696
  # @param simulcast_target_id [String] The ID of the simulcast target.
@@ -25,6 +25,7 @@ module MuxRuby
25
25
  # @param [Hash] opts the optional parameters
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[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
28
29
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
29
30
  # @option opts [String] :order_direction Sort order.
30
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 &#x60;minute&#x60;. Between 90 minutes and 6 hours, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
@@ -40,6 +41,7 @@ module MuxRuby
40
41
  # @param [Hash] opts the optional parameters
41
42
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
42
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
43
45
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
44
46
  # @option opts [String] :order_direction Sort order.
45
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 &#x60;minute&#x60;. Between 90 minutes and 6 hours, the default granularity is &#x60;ten_minutes&#x60;. Between 6 hours and 15 days inclusive, the default granularity is &#x60;hour&#x60;. The granularity of timeframes that exceed 15 days is &#x60;day&#x60;. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
@@ -53,7 +55,7 @@ module MuxRuby
53
55
  fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
54
56
  end
55
57
  # verify enum value
56
- allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "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"]
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"]
57
59
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
58
60
  fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
59
61
  end
@@ -76,6 +78,7 @@ module MuxRuby
76
78
  query_params = opts[:query_params] || {}
77
79
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
78
80
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
81
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
79
82
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
80
83
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
81
84
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
@@ -120,6 +123,7 @@ module MuxRuby
120
123
  # @param [Hash] opts the optional parameters
121
124
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
122
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
123
127
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
124
128
  # @return [GetOverallValuesResponse]
125
129
  def get_overall_values(metric_id, opts = {})
@@ -133,6 +137,7 @@ module MuxRuby
133
137
  # @param [Hash] opts the optional parameters
134
138
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
135
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
136
141
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
137
142
  # @return [Array<(GetOverallValuesResponse, Integer, Hash)>] GetOverallValuesResponse data, response status code and response headers
138
143
  def get_overall_values_with_http_info(metric_id, opts = {})
@@ -144,7 +149,7 @@ module MuxRuby
144
149
  fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
145
150
  end
146
151
  # verify enum value
147
- allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "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"]
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"]
148
153
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
149
154
  fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
150
155
  end
@@ -159,6 +164,7 @@ module MuxRuby
159
164
  query_params = opts[:query_params] || {}
160
165
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
161
166
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
167
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
162
168
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
163
169
 
164
170
  # header parameters
@@ -200,6 +206,7 @@ module MuxRuby
200
206
  # @param [Hash] opts the optional parameters
201
207
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
202
208
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
209
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
203
210
  # @option opts [String] :dimension Dimension the specified value belongs to
204
211
  # @option opts [String] :value Value to show all available metrics for
205
212
  # @return [ListAllMetricValuesResponse]
@@ -213,6 +220,7 @@ module MuxRuby
213
220
  # @param [Hash] opts the optional parameters
214
221
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
215
222
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
223
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
216
224
  # @option opts [String] :dimension Dimension the specified value belongs to
217
225
  # @option opts [String] :value Value to show all available metrics for
218
226
  # @return [Array<(ListAllMetricValuesResponse, Integer, Hash)>] ListAllMetricValuesResponse data, response status code and response headers
@@ -220,7 +228,7 @@ module MuxRuby
220
228
  if @api_client.config.debugging
221
229
  @api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
222
230
  end
223
- 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", "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_encoding_variant", "video_id", "video_series", "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"]
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"]
224
232
  if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
225
233
  fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
226
234
  end
@@ -231,6 +239,7 @@ module MuxRuby
231
239
  query_params = opts[:query_params] || {}
232
240
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
233
241
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
242
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
234
243
  query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
235
244
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
236
245
 
@@ -275,6 +284,7 @@ module MuxRuby
275
284
  # @option opts [String] :group_by Breakdown value to group the results by
276
285
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
277
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
278
288
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
279
289
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
280
290
  # @option opts [String] :order_by Value to order the results by
@@ -293,6 +303,7 @@ module MuxRuby
293
303
  # @option opts [String] :group_by Breakdown value to group the results by
294
304
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
295
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
296
307
  # @option opts [Integer] :limit Number of items to include in the response
297
308
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
298
309
  # @option opts [String] :order_by Value to order the results by
@@ -308,11 +319,11 @@ module MuxRuby
308
319
  fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
309
320
  end
310
321
  # verify enum value
311
- allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "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"]
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"]
312
323
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
313
324
  fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
314
325
  end
315
- 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", "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_encoding_variant", "video_id", "video_series", "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"]
316
327
  if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
317
328
  fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
318
329
  end
@@ -336,6 +347,7 @@ module MuxRuby
336
347
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
337
348
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
338
349
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
350
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
339
351
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
340
352
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
341
353
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
@@ -383,6 +395,8 @@ module MuxRuby
383
395
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
384
396
  # @option opts [String] :order_direction Sort order.
385
397
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
399
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
386
400
  # @return [ListInsightsResponse]
387
401
  def list_insights(metric_id, opts = {})
388
402
  data, _status_code, _headers = list_insights_with_http_info(metric_id, opts)
@@ -396,6 +410,8 @@ module MuxRuby
396
410
  # @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
397
411
  # @option opts [String] :order_direction Sort order.
398
412
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
414
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
399
415
  # @return [Array<(ListInsightsResponse, Integer, Hash)>] ListInsightsResponse data, response status code and response headers
400
416
  def list_insights_with_http_info(metric_id, opts = {})
401
417
  if @api_client.config.debugging
@@ -406,7 +422,7 @@ module MuxRuby
406
422
  fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
407
423
  end
408
424
  # verify enum value
409
- allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "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"]
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"]
410
426
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
411
427
  fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
412
428
  end
@@ -426,6 +442,8 @@ module MuxRuby
426
442
  query_params[:'measurement'] = opts[:'measurement'] if !opts[:'measurement'].nil?
427
443
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
428
444
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
445
+ query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
446
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
429
447
 
430
448
  # header parameters
431
449
  header_params = opts[:header_params] || {}
@@ -19,7 +19,7 @@ module MuxRuby
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Retrieve an Asset or Live Stream ID
22
+ # Retrieve an asset or live stream ID
23
23
  # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
24
24
  # @param playback_id [String] The live stream&#39;s playback ID.
25
25
  # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module MuxRuby
29
29
  data
30
30
  end
31
31
 
32
- # Retrieve an Asset or Live Stream ID
32
+ # Retrieve an asset or live stream ID
33
33
  # Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
34
34
  # @param playback_id [String] The live stream&#39;s playback ID.
35
35
  # @param [Hash] opts the optional parameters
@@ -91,6 +91,7 @@ module MuxRuby
91
91
  # @option opts [Integer] :error_id Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
92
92
  # @option opts [String] :order_direction Sort order.
93
93
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
94
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
94
95
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
95
96
  # @return [ListVideoViewsResponse]
96
97
  def list_video_views(opts = {})
@@ -107,6 +108,7 @@ module MuxRuby
107
108
  # @option opts [Integer] :error_id Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
108
109
  # @option opts [String] :order_direction Sort order.
109
110
  # @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 &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60;
111
+ # @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 &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60;
110
112
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
111
113
  # @return [Array<(ListVideoViewsResponse, Integer, Hash)>] ListVideoViewsResponse data, response status code and response headers
112
114
  def list_video_views_with_http_info(opts = {})
@@ -128,6 +130,7 @@ module MuxRuby
128
130
  query_params[:'error_id'] = opts[:'error_id'] if !opts[:'error_id'].nil?
129
131
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
130
132
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
133
+ query_params[:'metric_filters[]'] = @api_client.build_collection_param(opts[:'metric_filters'], :multi) if !opts[:'metric_filters'].nil?
131
134
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
132
135
 
133
136
  # header parameters