mux_ruby 1.9.0 → 2.0.0.pre.rc.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +26 -37
  4. data/README.md +36 -13
  5. data/docs/AbridgedVideoView.md +33 -13
  6. data/docs/Asset.md +57 -26
  7. data/docs/AssetErrors.md +15 -4
  8. data/docs/AssetMaster.md +15 -4
  9. data/docs/AssetNonStandardInputReasons.md +29 -11
  10. data/docs/AssetRecordingTimes.md +15 -4
  11. data/docs/AssetResponse.md +13 -3
  12. data/docs/AssetStaticRenditions.md +15 -4
  13. data/docs/AssetStaticRenditionsFiles.md +23 -8
  14. data/docs/AssetsApi.md +387 -160
  15. data/docs/BreakdownValue.md +21 -7
  16. data/docs/CreateAssetRequest.md +27 -10
  17. data/docs/CreateLiveStreamRequest.md +25 -9
  18. data/docs/CreatePlaybackIDRequest.md +13 -3
  19. data/docs/CreatePlaybackIDResponse.md +13 -3
  20. data/docs/CreateSimulcastTargetRequest.md +17 -5
  21. data/docs/CreateTrackRequest.md +25 -9
  22. data/docs/CreateTrackResponse.md +13 -3
  23. data/docs/CreateUploadRequest.md +19 -6
  24. data/docs/DeliveryReport.md +27 -9
  25. data/docs/DeliveryUsageApi.md +40 -22
  26. data/docs/DimensionValue.md +15 -4
  27. data/docs/DimensionsApi.md +72 -34
  28. data/docs/DirectUploadsApi.md +131 -56
  29. data/docs/DisableLiveStreamResponse.md +13 -3
  30. data/docs/EnableLiveStreamResponse.md +13 -3
  31. data/docs/Error.md +27 -10
  32. data/docs/ErrorsApi.md +37 -19
  33. data/docs/ExportsApi.md +32 -13
  34. data/docs/FilterValue.md +15 -4
  35. data/docs/FiltersApi.md +71 -33
  36. data/docs/GetAssetInputInfoResponse.md +13 -3
  37. data/docs/GetAssetOrLiveStreamIdResponse.md +13 -3
  38. data/docs/GetAssetOrLiveStreamIdResponseData.md +17 -5
  39. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +15 -4
  40. data/docs/GetAssetPlaybackIDResponse.md +13 -3
  41. data/docs/GetMetricTimeseriesDataResponse.md +17 -5
  42. data/docs/GetOverallValuesResponse.md +17 -5
  43. data/docs/GetRealTimeBreakdownResponse.md +17 -5
  44. data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
  45. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
  46. data/docs/GetRealTimeTimeseriesResponse.md +17 -5
  47. data/docs/Incident.md +53 -23
  48. data/docs/IncidentBreakdown.md +17 -5
  49. data/docs/IncidentNotification.md +17 -5
  50. data/docs/IncidentNotificationRule.md +21 -7
  51. data/docs/IncidentResponse.md +15 -4
  52. data/docs/IncidentsApi.md +115 -59
  53. data/docs/InputFile.md +15 -4
  54. data/docs/InputInfo.md +15 -4
  55. data/docs/InputSettings.md +31 -12
  56. data/docs/InputSettingsOverlaySettings.md +25 -9
  57. data/docs/InputTrack.md +29 -11
  58. data/docs/Insight.md +23 -8
  59. data/docs/ListAllMetricValuesResponse.md +17 -5
  60. data/docs/ListAssetsResponse.md +13 -3
  61. data/docs/ListBreakdownValuesResponse.md +17 -5
  62. data/docs/ListDeliveryUsageResponse.md +19 -6
  63. data/docs/ListDimensionValuesResponse.md +17 -5
  64. data/docs/ListDimensionsResponse.md +17 -5
  65. data/docs/ListErrorsResponse.md +17 -5
  66. data/docs/ListExportsResponse.md +17 -5
  67. data/docs/ListFilterValuesResponse.md +17 -5
  68. data/docs/ListFiltersResponse.md +17 -5
  69. data/docs/ListFiltersResponseData.md +15 -4
  70. data/docs/ListIncidentsResponse.md +17 -5
  71. data/docs/ListInsightsResponse.md +17 -5
  72. data/docs/ListLiveStreamsResponse.md +13 -3
  73. data/docs/ListRealTimeDimensionsResponse.md +17 -5
  74. data/docs/ListRealTimeDimensionsResponseData.md +15 -4
  75. data/docs/ListRealTimeMetricsResponse.md +17 -5
  76. data/docs/ListRelatedIncidentsResponse.md +17 -5
  77. data/docs/ListSigningKeysResponse.md +13 -3
  78. data/docs/ListUploadsResponse.md +13 -3
  79. data/docs/ListVideoViewsResponse.md +17 -5
  80. data/docs/LiveStream.md +37 -15
  81. data/docs/LiveStreamResponse.md +13 -3
  82. data/docs/LiveStreamsApi.md +418 -170
  83. data/docs/Metric.md +21 -7
  84. data/docs/MetricsApi.md +206 -112
  85. data/docs/NotificationRule.md +17 -5
  86. data/docs/OverallValues.md +19 -6
  87. data/docs/PlaybackID.md +15 -4
  88. data/docs/PlaybackIDApi.md +34 -16
  89. data/docs/PlaybackPolicy.md +10 -2
  90. data/docs/RealTimeApi.md +172 -76
  91. data/docs/RealTimeBreakdownValue.md +21 -7
  92. data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
  93. data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
  94. data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
  95. data/docs/RealTimeTimeseriesDatapoint.md +17 -5
  96. data/docs/Score.md +23 -8
  97. data/docs/SignalLiveStreamCompleteResponse.md +13 -3
  98. data/docs/SigningKey.md +17 -5
  99. data/docs/SigningKeyResponse.md +13 -3
  100. data/docs/SimulcastTarget.md +21 -7
  101. data/docs/SimulcastTargetResponse.md +13 -3
  102. data/docs/Track.md +37 -15
  103. data/docs/URLSigningKeysApi.md +127 -51
  104. data/docs/UpdateAssetMP4SupportRequest.md +13 -3
  105. data/docs/UpdateAssetMasterAccessRequest.md +13 -3
  106. data/docs/Upload.md +29 -11
  107. data/docs/UploadError.md +15 -4
  108. data/docs/UploadResponse.md +13 -3
  109. data/docs/VideoView.md +235 -114
  110. data/docs/VideoViewEvent.md +19 -6
  111. data/docs/VideoViewResponse.md +15 -4
  112. data/docs/VideoViewsApi.md +76 -39
  113. data/gen/.gitignore +7 -0
  114. data/gen/Makefile +31 -0
  115. data/gen/generator-config.json +11 -0
  116. data/gen/openapitools.json +7 -0
  117. data/gen/package.json +17 -0
  118. data/gen/templates/Gemfile.mustache +11 -0
  119. data/gen/templates/README.mustache +158 -0
  120. data/gen/templates/Rakefile.mustache +10 -0
  121. data/gen/templates/api.mustache +206 -0
  122. data/gen/templates/api_client.mustache +264 -0
  123. data/gen/templates/api_client_faraday_partial.mustache +138 -0
  124. data/gen/templates/api_client_spec.mustache +220 -0
  125. data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
  126. data/gen/templates/api_doc.mustache +118 -0
  127. data/gen/templates/api_error.mustache +67 -0
  128. data/gen/templates/api_info.mustache +12 -0
  129. data/gen/templates/api_test.mustache +47 -0
  130. data/gen/templates/base_object.mustache +120 -0
  131. data/gen/templates/configuration.mustache +349 -0
  132. data/gen/templates/configuration_spec.mustache +34 -0
  133. data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
  134. data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  135. data/gen/templates/gem.mustache +40 -0
  136. data/gen/templates/gemspec.mustache +35 -0
  137. data/gen/templates/gitignore.mustache +39 -0
  138. data/gen/templates/model.mustache +26 -0
  139. data/gen/templates/model_doc.mustache +12 -0
  140. data/gen/templates/model_test.mustache +77 -0
  141. data/gen/templates/partial_model_enum_class.mustache +20 -0
  142. data/gen/templates/partial_model_generic.mustache +371 -0
  143. data/gen/templates/partial_model_generic_doc.mustache +28 -0
  144. data/gen/templates/partial_oneof_module.mustache +137 -0
  145. data/gen/templates/partial_oneof_module_doc.mustache +92 -0
  146. data/gen/templates/rspec.mustache +2 -0
  147. data/gen/templates/rubocop.mustache +148 -0
  148. data/gen/templates/spec_helper.mustache +103 -0
  149. data/gen/templates/version.mustache +7 -0
  150. data/gen/yarn.lock +1878 -0
  151. data/lib/mux_ruby.rb +9 -2
  152. data/lib/mux_ruby/api/assets_api.rb +279 -150
  153. data/lib/mux_ruby/api/delivery_usage_api.rb +28 -12
  154. data/lib/mux_ruby/api/dimensions_api.rb +55 -29
  155. data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
  156. data/lib/mux_ruby/api/errors_api.rb +32 -16
  157. data/lib/mux_ruby/api/exports_api.rb +28 -12
  158. data/lib/mux_ruby/api/filters_api.rb +53 -27
  159. data/lib/mux_ruby/api/incidents_api.rb +88 -46
  160. data/lib/mux_ruby/api/live_streams_api.rb +299 -157
  161. data/lib/mux_ruby/api/metrics_api.rb +175 -104
  162. data/lib/mux_ruby/api/playback_id_api.rb +31 -15
  163. data/lib/mux_ruby/api/real_time_api.rb +139 -77
  164. data/lib/mux_ruby/api/url_signing_keys_api.rb +89 -42
  165. data/lib/mux_ruby/api/video_views_api.rb +56 -29
  166. data/lib/mux_ruby/api_client.rb +94 -79
  167. data/lib/mux_ruby/api_error.rb +35 -7
  168. data/lib/mux_ruby/configuration.rb +50 -14
  169. data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
  170. data/lib/mux_ruby/models/asset.rb +88 -61
  171. data/lib/mux_ruby/models/asset_errors.rb +50 -15
  172. data/lib/mux_ruby/models/asset_master.rb +52 -17
  173. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +70 -35
  174. data/lib/mux_ruby/models/asset_recording_times.rb +50 -16
  175. data/lib/mux_ruby/models/asset_response.rb +48 -14
  176. data/lib/mux_ruby/models/asset_static_renditions.rb +53 -17
  177. data/lib/mux_ruby/models/asset_static_renditions_files.rb +58 -23
  178. data/lib/mux_ruby/models/breakdown_value.rb +52 -18
  179. data/lib/mux_ruby/models/create_asset_request.rb +64 -30
  180. data/lib/mux_ruby/models/create_live_stream_request.rb +57 -22
  181. data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
  182. data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
  183. data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
  184. data/lib/mux_ruby/models/create_track_request.rb +59 -25
  185. data/lib/mux_ruby/models/create_track_response.rb +48 -14
  186. data/lib/mux_ruby/models/create_upload_request.rb +52 -18
  187. data/lib/mux_ruby/models/delivery_report.rb +106 -21
  188. data/lib/mux_ruby/models/dimension_value.rb +49 -15
  189. data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
  190. data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
  191. data/lib/mux_ruby/models/error.rb +63 -21
  192. data/lib/mux_ruby/models/filter_value.rb +49 -15
  193. data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
  194. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +48 -14
  195. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +50 -16
  196. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +51 -17
  197. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
  198. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
  199. data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
  200. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
  201. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
  202. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
  203. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
  204. data/lib/mux_ruby/models/incident.rb +68 -34
  205. data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
  206. data/lib/mux_ruby/models/incident_notification.rb +50 -16
  207. data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
  208. data/lib/mux_ruby/models/incident_response.rb +49 -15
  209. data/lib/mux_ruby/models/input_file.rb +49 -15
  210. data/lib/mux_ruby/models/input_info.rb +49 -15
  211. data/lib/mux_ruby/models/input_settings.rb +64 -30
  212. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +58 -24
  213. data/lib/mux_ruby/models/input_track.rb +56 -22
  214. data/lib/mux_ruby/models/insight.rb +53 -19
  215. data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
  216. data/lib/mux_ruby/models/list_assets_response.rb +48 -14
  217. data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
  218. data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
  219. data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
  220. data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
  221. data/lib/mux_ruby/models/list_errors_response.rb +50 -16
  222. data/lib/mux_ruby/models/list_exports_response.rb +50 -16
  223. data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
  224. data/lib/mux_ruby/models/list_filters_response.rb +50 -16
  225. data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
  226. data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
  227. data/lib/mux_ruby/models/list_insights_response.rb +50 -16
  228. data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
  229. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
  230. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
  231. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
  232. data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
  233. data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
  234. data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
  235. data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
  236. data/lib/mux_ruby/models/live_stream.rb +110 -28
  237. data/lib/mux_ruby/models/live_stream_response.rb +48 -14
  238. data/lib/mux_ruby/models/metric.rb +52 -18
  239. data/lib/mux_ruby/models/notification_rule.rb +50 -16
  240. data/lib/mux_ruby/models/overall_values.rb +51 -17
  241. data/lib/mux_ruby/models/playback_id.rb +49 -15
  242. data/lib/mux_ruby/models/playback_policy.rb +12 -6
  243. data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
  244. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
  245. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
  246. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
  247. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
  248. data/lib/mux_ruby/models/score.rb +53 -19
  249. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
  250. data/lib/mux_ruby/models/signing_key.rb +53 -16
  251. data/lib/mux_ruby/models/signing_key_response.rb +48 -14
  252. data/lib/mux_ruby/models/simulcast_target.rb +54 -20
  253. data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
  254. data/lib/mux_ruby/models/track.rb +67 -33
  255. data/lib/mux_ruby/models/update_asset_master_access_request.rb +50 -16
  256. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +50 -16
  257. data/lib/mux_ruby/models/upload.rb +61 -25
  258. data/lib/mux_ruby/models/upload_error.rb +51 -15
  259. data/lib/mux_ruby/models/upload_response.rb +48 -14
  260. data/lib/mux_ruby/models/video_view.rb +166 -132
  261. data/lib/mux_ruby/models/video_view_event.rb +51 -17
  262. data/lib/mux_ruby/models/video_view_response.rb +49 -15
  263. data/lib/mux_ruby/version.rb +10 -3
  264. data/mux_ruby.gemspec +15 -17
  265. data/spec/api_client_spec.rb +10 -3
  266. data/spec/configuration_spec.rb +9 -2
  267. data/spec/spec_helper.rb +9 -2
  268. metadata +139 -242
data/docs/UpdateAssetMP4SupportRequest.md CHANGED
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::UpdateAssetMP4SupportRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **mp4_support** | **String** | String value for the level of mp4 support | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **mp4_support** | **String** | String value for the level of mp4 support | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UpdateAssetMP4SupportRequest.new(
15
+ mp4_support: null
16
+ )
17
+ ```
8
18
 
data/docs/UpdateAssetMasterAccessRequest.md CHANGED
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::UpdateAssetMasterAccessRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **master_access** | **String** | Add or remove access to the master version of the video. | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **master_access** | **String** | Add or remove access to the master version of the video. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UpdateAssetMasterAccessRequest.new(
15
+ master_access: null
16
+ )
17
+ ```
8
18
 
data/docs/Upload.md CHANGED
@@ -1,16 +1,34 @@
1
1
  # MuxRuby::Upload
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
- **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600]
8
- **status** | **String** | | [optional]
9
- **new_asset_settings** | [**Asset**](Asset.md) | | [optional]
10
- **asset_id** | **String** | Only set once the upload is in the `asset_created` state. | [optional]
11
- **error** | [**UploadError**](UploadError.md) | | [optional]
12
- **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional]
13
- **url** | **String** | The URL to upload the associated source media to. | [optional]
14
- **test** | **BOOLEAN** | | [optional]
15
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Direct Upload. | [optional] |
8
+ | **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional][default to 3600] |
9
+ | **status** | **String** | | [optional] |
10
+ | **new_asset_settings** | [**Asset**](Asset.md) | | [optional] |
11
+ | **asset_id** | **String** | Only set once the upload is in the `asset_created` state. | [optional] |
12
+ | **error** | [**UploadError**](UploadError.md) | | [optional] |
13
+ | **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] |
14
+ | **url** | **String** | The URL to upload the associated source media to. | [optional] |
15
+ | **test** | **Boolean** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a `test` Asset. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'mux_ruby'
21
+
22
+ instance = MuxRuby::Upload.new(
23
+ id: null,
24
+ timeout: null,
25
+ status: null,
26
+ new_asset_settings: null,
27
+ asset_id: null,
28
+ error: null,
29
+ cors_origin: null,
30
+ url: null,
31
+ test: null
32
+ )
33
+ ```
16
34
 
data/docs/UploadError.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::UploadError
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | | [optional]
7
- **message** | **String** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Label for the specific error | [optional] |
8
+ | **message** | **String** | Human readable error message | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::UploadError.new(
16
+ type: null,
17
+ message: null
18
+ )
19
+ ```
9
20
 
data/docs/UploadResponse.md CHANGED
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::UploadResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Upload**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Upload**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UploadResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
data/docs/VideoView.md CHANGED
@@ -1,119 +1,240 @@
1
1
  # MuxRuby::VideoView
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **view_total_upscaling** | **String** | | [optional]
7
- **preroll_ad_asset_hostname** | **String** | | [optional]
8
- **player_source_domain** | **String** | | [optional]
9
- **region** | **String** | | [optional]
10
- **viewer_user_agent** | **String** | | [optional]
11
- **preroll_requested** | **BOOLEAN** | | [optional]
12
- **page_type** | **String** | | [optional]
13
- **startup_score** | **String** | | [optional]
14
- **view_seek_duration** | **Integer** | | [optional]
15
- **country_name** | **String** | | [optional]
16
- **player_source_height** | **Integer** | | [optional]
17
- **longitude** | **String** | | [optional]
18
- **buffering_count** | **Integer** | | [optional]
19
- **video_duration** | **Integer** | | [optional]
20
- **player_source_type** | **String** | | [optional]
21
- **city** | **String** | | [optional]
22
- **view_id** | **String** | | [optional]
23
- **platform_description** | **String** | | [optional]
24
- **video_startup_preroll_request_time** | **Integer** | | [optional]
25
- **viewer_device_name** | **String** | | [optional]
26
- **video_series** | **String** | | [optional]
27
- **viewer_application_name** | **String** | | [optional]
28
- **updated_at** | **String** | | [optional]
29
- **view_total_content_playback_time** | **Integer** | | [optional]
30
- **cdn** | **String** | | [optional]
31
- **player_instance_id** | **String** | | [optional]
32
- **video_language** | **String** | | [optional]
33
- **player_source_width** | **Integer** | | [optional]
34
- **player_error_message** | **String** | | [optional]
35
- **player_mux_plugin_version** | **String** | | [optional]
36
- **watched** | **BOOLEAN** | | [optional]
37
- **playback_score** | **String** | | [optional]
38
- **page_url** | **String** | | [optional]
39
- **metro** | **String** | | [optional]
40
- **view_max_request_latency** | **Integer** | | [optional]
41
- **requests_for_first_preroll** | **Integer** | | [optional]
42
- **view_total_downscaling** | **String** | | [optional]
43
- **latitude** | **String** | | [optional]
44
- **player_source_host_name** | **String** | | [optional]
45
- **inserted_at** | **String** | | [optional]
46
- **view_end** | **String** | | [optional]
47
- **mux_embed_version** | **String** | | [optional]
48
- **player_language** | **String** | | [optional]
49
- **page_load_time** | **Integer** | | [optional]
50
- **viewer_device_category** | **String** | | [optional]
51
- **video_startup_preroll_load_time** | **Integer** | | [optional]
52
- **player_version** | **String** | | [optional]
53
- **watch_time** | **Integer** | | [optional]
54
- **player_source_stream_type** | **String** | | [optional]
55
- **preroll_ad_tag_hostname** | **String** | | [optional]
56
- **viewer_device_manufacturer** | **String** | | [optional]
57
- **rebuffering_score** | **String** | | [optional]
58
- **experiment_name** | **String** | | [optional]
59
- **viewer_os_version** | **String** | | [optional]
60
- **player_preload** | **BOOLEAN** | | [optional]
61
- **buffering_duration** | **Integer** | | [optional]
62
- **player_view_count** | **Integer** | | [optional]
63
- **player_software** | **String** | | [optional]
64
- **player_load_time** | **Integer** | | [optional]
65
- **platform_summary** | **String** | | [optional]
66
- **video_encoding_variant** | **String** | | [optional]
67
- **player_width** | **Integer** | | [optional]
68
- **view_seek_count** | **Integer** | | [optional]
69
- **viewer_experience_score** | **String** | | [optional]
70
- **view_error_id** | **Integer** | | [optional]
71
- **video_variant_name** | **String** | | [optional]
72
- **preroll_played** | **BOOLEAN** | | [optional]
73
- **viewer_application_engine** | **String** | | [optional]
74
- **viewer_os_architecture** | **String** | | [optional]
75
- **player_error_code** | **String** | | [optional]
76
- **buffering_rate** | **String** | | [optional]
77
- **events** | [**Array<VideoViewEvent>**](VideoViewEvent.md) | | [optional]
78
- **player_name** | **String** | | [optional]
79
- **view_start** | **String** | | [optional]
80
- **view_average_request_throughput** | **Integer** | | [optional]
81
- **video_producer** | **String** | | [optional]
82
- **error_type_id** | **Integer** | | [optional]
83
- **mux_viewer_id** | **String** | | [optional]
84
- **video_id** | **String** | | [optional]
85
- **continent_code** | **String** | | [optional]
86
- **session_id** | **String** | | [optional]
87
- **exit_before_video_start** | **BOOLEAN** | | [optional]
88
- **video_content_type** | **String** | | [optional]
89
- **viewer_os_family** | **String** | | [optional]
90
- **player_poster** | **String** | | [optional]
91
- **view_average_request_latency** | **Integer** | | [optional]
92
- **video_variant_id** | **String** | | [optional]
93
- **player_source_duration** | **Integer** | | [optional]
94
- **player_source_url** | **String** | | [optional]
95
- **mux_api_version** | **String** | | [optional]
96
- **video_title** | **String** | | [optional]
97
- **id** | **String** | | [optional]
98
- **short_time** | **String** | | [optional]
99
- **rebuffer_percentage** | **String** | | [optional]
100
- **time_to_first_frame** | **Integer** | | [optional]
101
- **viewer_user_id** | **String** | | [optional]
102
- **video_stream_type** | **String** | | [optional]
103
- **player_startup_time** | **Integer** | | [optional]
104
- **viewer_application_version** | **String** | | [optional]
105
- **view_max_downscale_percentage** | **String** | | [optional]
106
- **view_max_upscale_percentage** | **String** | | [optional]
107
- **country_code** | **String** | | [optional]
108
- **used_fullscreen** | **BOOLEAN** | | [optional]
109
- **isp** | **String** | | [optional]
110
- **property_id** | **Integer** | | [optional]
111
- **player_autoplay** | **BOOLEAN** | | [optional]
112
- **player_height** | **Integer** | | [optional]
113
- **asn** | **Integer** | | [optional]
114
- **asn_name** | **String** | | [optional]
115
- **quality_score** | **String** | | [optional]
116
- **player_software_version** | **String** | | [optional]
117
- **player_mux_plugin_name** | **String** | | [optional]
118
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **view_total_upscaling** | **String** | | [optional] |
8
+ | **preroll_ad_asset_hostname** | **String** | | [optional] |
9
+ | **player_source_domain** | **String** | | [optional] |
10
+ | **region** | **String** | | [optional] |
11
+ | **viewer_user_agent** | **String** | | [optional] |
12
+ | **preroll_requested** | **Boolean** | | [optional] |
13
+ | **page_type** | **String** | | [optional] |
14
+ | **startup_score** | **String** | | [optional] |
15
+ | **view_seek_duration** | **Integer** | | [optional] |
16
+ | **country_name** | **String** | | [optional] |
17
+ | **player_source_height** | **Integer** | | [optional] |
18
+ | **longitude** | **String** | | [optional] |
19
+ | **buffering_count** | **Integer** | | [optional] |
20
+ | **video_duration** | **Integer** | | [optional] |
21
+ | **player_source_type** | **String** | | [optional] |
22
+ | **city** | **String** | | [optional] |
23
+ | **view_id** | **String** | | [optional] |
24
+ | **platform_description** | **String** | | [optional] |
25
+ | **video_startup_preroll_request_time** | **Integer** | | [optional] |
26
+ | **viewer_device_name** | **String** | | [optional] |
27
+ | **video_series** | **String** | | [optional] |
28
+ | **viewer_application_name** | **String** | | [optional] |
29
+ | **updated_at** | **String** | | [optional] |
30
+ | **view_total_content_playback_time** | **Integer** | | [optional] |
31
+ | **cdn** | **String** | | [optional] |
32
+ | **player_instance_id** | **String** | | [optional] |
33
+ | **video_language** | **String** | | [optional] |
34
+ | **player_source_width** | **Integer** | | [optional] |
35
+ | **player_error_message** | **String** | | [optional] |
36
+ | **player_mux_plugin_version** | **String** | | [optional] |
37
+ | **watched** | **Boolean** | | [optional] |
38
+ | **playback_score** | **String** | | [optional] |
39
+ | **page_url** | **String** | | [optional] |
40
+ | **metro** | **String** | | [optional] |
41
+ | **view_max_request_latency** | **Integer** | | [optional] |
42
+ | **requests_for_first_preroll** | **Integer** | | [optional] |
43
+ | **view_total_downscaling** | **String** | | [optional] |
44
+ | **latitude** | **String** | | [optional] |
45
+ | **player_source_host_name** | **String** | | [optional] |
46
+ | **inserted_at** | **String** | | [optional] |
47
+ | **view_end** | **String** | | [optional] |
48
+ | **mux_embed_version** | **String** | | [optional] |
49
+ | **player_language** | **String** | | [optional] |
50
+ | **page_load_time** | **Integer** | | [optional] |
51
+ | **viewer_device_category** | **String** | | [optional] |
52
+ | **video_startup_preroll_load_time** | **Integer** | | [optional] |
53
+ | **player_version** | **String** | | [optional] |
54
+ | **watch_time** | **Integer** | | [optional] |
55
+ | **player_source_stream_type** | **String** | | [optional] |
56
+ | **preroll_ad_tag_hostname** | **String** | | [optional] |
57
+ | **viewer_device_manufacturer** | **String** | | [optional] |
58
+ | **rebuffering_score** | **String** | | [optional] |
59
+ | **experiment_name** | **String** | | [optional] |
60
+ | **viewer_os_version** | **String** | | [optional] |
61
+ | **player_preload** | **Boolean** | | [optional] |
62
+ | **buffering_duration** | **Integer** | | [optional] |
63
+ | **player_view_count** | **Integer** | | [optional] |
64
+ | **player_software** | **String** | | [optional] |
65
+ | **player_load_time** | **Integer** | | [optional] |
66
+ | **platform_summary** | **String** | | [optional] |
67
+ | **video_encoding_variant** | **String** | | [optional] |
68
+ | **player_width** | **Integer** | | [optional] |
69
+ | **view_seek_count** | **Integer** | | [optional] |
70
+ | **viewer_experience_score** | **String** | | [optional] |
71
+ | **view_error_id** | **Integer** | | [optional] |
72
+ | **video_variant_name** | **String** | | [optional] |
73
+ | **preroll_played** | **Boolean** | | [optional] |
74
+ | **viewer_application_engine** | **String** | | [optional] |
75
+ | **viewer_os_architecture** | **String** | | [optional] |
76
+ | **player_error_code** | **String** | | [optional] |
77
+ | **buffering_rate** | **String** | | [optional] |
78
+ | **events** | [**Array<VideoViewEvent>**](VideoViewEvent.md) | | [optional] |
79
+ | **player_name** | **String** | | [optional] |
80
+ | **view_start** | **String** | | [optional] |
81
+ | **view_average_request_throughput** | **Integer** | | [optional] |
82
+ | **video_producer** | **String** | | [optional] |
83
+ | **error_type_id** | **Integer** | | [optional] |
84
+ | **mux_viewer_id** | **String** | | [optional] |
85
+ | **video_id** | **String** | | [optional] |
86
+ | **continent_code** | **String** | | [optional] |
87
+ | **session_id** | **String** | | [optional] |
88
+ | **exit_before_video_start** | **Boolean** | | [optional] |
89
+ | **video_content_type** | **String** | | [optional] |
90
+ | **viewer_os_family** | **String** | | [optional] |
91
+ | **player_poster** | **String** | | [optional] |
92
+ | **view_average_request_latency** | **Integer** | | [optional] |
93
+ | **video_variant_id** | **String** | | [optional] |
94
+ | **player_source_duration** | **Integer** | | [optional] |
95
+ | **player_source_url** | **String** | | [optional] |
96
+ | **mux_api_version** | **String** | | [optional] |
97
+ | **video_title** | **String** | | [optional] |
98
+ | **id** | **String** | | [optional] |
99
+ | **short_time** | **String** | | [optional] |
100
+ | **rebuffer_percentage** | **String** | | [optional] |
101
+ | **time_to_first_frame** | **Integer** | | [optional] |
102
+ | **viewer_user_id** | **String** | | [optional] |
103
+ | **video_stream_type** | **String** | | [optional] |
104
+ | **player_startup_time** | **Integer** | | [optional] |
105
+ | **viewer_application_version** | **String** | | [optional] |
106
+ | **view_max_downscale_percentage** | **String** | | [optional] |
107
+ | **view_max_upscale_percentage** | **String** | | [optional] |
108
+ | **country_code** | **String** | | [optional] |
109
+ | **used_fullscreen** | **Boolean** | | [optional] |
110
+ | **isp** | **String** | | [optional] |
111
+ | **property_id** | **Integer** | | [optional] |
112
+ | **player_autoplay** | **Boolean** | | [optional] |
113
+ | **player_height** | **Integer** | | [optional] |
114
+ | **asn** | **Integer** | | [optional] |
115
+ | **asn_name** | **String** | | [optional] |
116
+ | **quality_score** | **String** | | [optional] |
117
+ | **player_software_version** | **String** | | [optional] |
118
+ | **player_mux_plugin_name** | **String** | | [optional] |
119
+
120
+ ## Example
121
+
122
+ ```ruby
123
+ require 'mux_ruby'
124
+
125
+ instance = MuxRuby::VideoView.new(
126
+ view_total_upscaling: null,
127
+ preroll_ad_asset_hostname: null,
128
+ player_source_domain: null,
129
+ region: null,
130
+ viewer_user_agent: null,
131
+ preroll_requested: null,
132
+ page_type: null,
133
+ startup_score: null,
134
+ view_seek_duration: null,
135
+ country_name: null,
136
+ player_source_height: null,
137
+ longitude: null,
138
+ buffering_count: null,
139
+ video_duration: null,
140
+ player_source_type: null,
141
+ city: null,
142
+ view_id: null,
143
+ platform_description: null,
144
+ video_startup_preroll_request_time: null,
145
+ viewer_device_name: null,
146
+ video_series: null,
147
+ viewer_application_name: null,
148
+ updated_at: null,
149
+ view_total_content_playback_time: null,
150
+ cdn: null,
151
+ player_instance_id: null,
152
+ video_language: null,
153
+ player_source_width: null,
154
+ player_error_message: null,
155
+ player_mux_plugin_version: null,
156
+ watched: null,
157
+ playback_score: null,
158
+ page_url: null,
159
+ metro: null,
160
+ view_max_request_latency: null,
161
+ requests_for_first_preroll: null,
162
+ view_total_downscaling: null,
163
+ latitude: null,
164
+ player_source_host_name: null,
165
+ inserted_at: null,
166
+ view_end: null,
167
+ mux_embed_version: null,
168
+ player_language: null,
169
+ page_load_time: null,
170
+ viewer_device_category: null,
171
+ video_startup_preroll_load_time: null,
172
+ player_version: null,
173
+ watch_time: null,
174
+ player_source_stream_type: null,
175
+ preroll_ad_tag_hostname: null,
176
+ viewer_device_manufacturer: null,
177
+ rebuffering_score: null,
178
+ experiment_name: null,
179
+ viewer_os_version: null,
180
+ player_preload: null,
181
+ buffering_duration: null,
182
+ player_view_count: null,
183
+ player_software: null,
184
+ player_load_time: null,
185
+ platform_summary: null,
186
+ video_encoding_variant: null,
187
+ player_width: null,
188
+ view_seek_count: null,
189
+ viewer_experience_score: null,
190
+ view_error_id: null,
191
+ video_variant_name: null,
192
+ preroll_played: null,
193
+ viewer_application_engine: null,
194
+ viewer_os_architecture: null,
195
+ player_error_code: null,
196
+ buffering_rate: null,
197
+ events: null,
198
+ player_name: null,
199
+ view_start: null,
200
+ view_average_request_throughput: null,
201
+ video_producer: null,
202
+ error_type_id: null,
203
+ mux_viewer_id: null,
204
+ video_id: null,
205
+ continent_code: null,
206
+ session_id: null,
207
+ exit_before_video_start: null,
208
+ video_content_type: null,
209
+ viewer_os_family: null,
210
+ player_poster: null,
211
+ view_average_request_latency: null,
212
+ video_variant_id: null,
213
+ player_source_duration: null,
214
+ player_source_url: null,
215
+ mux_api_version: null,
216
+ video_title: null,
217
+ id: null,
218
+ short_time: null,
219
+ rebuffer_percentage: null,
220
+ time_to_first_frame: null,
221
+ viewer_user_id: null,
222
+ video_stream_type: null,
223
+ player_startup_time: null,
224
+ viewer_application_version: null,
225
+ view_max_downscale_percentage: null,
226
+ view_max_upscale_percentage: null,
227
+ country_code: null,
228
+ used_fullscreen: null,
229
+ isp: null,
230
+ property_id: null,
231
+ player_autoplay: null,
232
+ player_height: null,
233
+ asn: null,
234
+ asn_name: null,
235
+ quality_score: null,
236
+ player_software_version: null,
237
+ player_mux_plugin_name: null
238
+ )
239
+ ```
119
240