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
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::NotificationRule
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **String** | | [optional]
7
- **name** | **String** | | [optional]
8
- **id** | **String** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+ | **id** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::NotificationRule.new(
17
+ value: null,
18
+ name: null,
19
+ id: null
20
+ )
21
+ ```
10
22
 
@@ -1,11 +1,24 @@
1
1
  # MuxRuby::OverallValues
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **Float** | | [optional]
7
- **total_watch_time** | **Integer** | | [optional]
8
- **total_views** | **Integer** | | [optional]
9
- **global_value** | **Float** | | [optional]
10
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Float** | | [optional] |
8
+ | **total_watch_time** | **Integer** | | [optional] |
9
+ | **total_views** | **Integer** | | [optional] |
10
+ | **global_value** | **Float** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mux_ruby'
16
+
17
+ instance = MuxRuby::OverallValues.new(
18
+ value: null,
19
+ total_watch_time: null,
20
+ total_views: null,
21
+ global_value: null
22
+ )
23
+ ```
11
24
 
data/docs/PlaybackID.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::PlaybackID
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | Unique identifier for the PlaybackID | [optional]
7
- **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the PlaybackID | [optional] |
8
+ | **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::PlaybackID.new(
16
+ id: null,
17
+ policy: null
18
+ )
19
+ ```
9
20
 
@@ -2,21 +2,23 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an Asset or Live Stream ID
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_asset_or_livestream_id**](PlaybackIDApi.md#get_asset_or_livestream_id) | **GET** /video/v1/playback-ids/{PLAYBACK_ID} | Retrieve an Asset or Live Stream ID |
8
8
 
9
9
 
10
- # **get_asset_or_livestream_id**
11
- > GetAssetOrLiveStreamIdResponse get_asset_or_livestream_id(playback_id)
10
+ ## get_asset_or_livestream_id
11
+
12
+ > <GetAssetOrLiveStreamIdResponse> get_asset_or_livestream_id(playback_id)
12
13
 
13
14
  Retrieve an Asset or Live Stream ID
14
15
 
15
16
  Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.
16
17
 
17
- ### Example
18
+ ### Examples
19
+
18
20
  ```ruby
19
- # load the gem
21
+ require 'time'
20
22
  require 'mux_ruby'
21
23
  # setup authorization
22
24
  MuxRuby.configure do |config|
@@ -29,19 +31,37 @@ api_instance = MuxRuby::PlaybackIDApi.new
29
31
  playback_id = 'playback_id_example' # String | The live stream's playback ID.
30
32
 
31
33
  begin
32
- #Retrieve an Asset or Live Stream ID
34
+ # Retrieve an Asset or Live Stream ID
33
35
  result = api_instance.get_asset_or_livestream_id(playback_id)
34
36
  p result
35
37
  rescue MuxRuby::ApiError => e
36
- puts "Exception when calling PlaybackIDApi->get_asset_or_livestream_id: #{e}"
38
+ puts "Error when calling PlaybackIDApi->get_asset_or_livestream_id: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the get_asset_or_livestream_id_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<GetAssetOrLiveStreamIdResponse>, Integer, Hash)> get_asset_or_livestream_id_with_http_info(playback_id)
47
+
48
+ ```ruby
49
+ begin
50
+ # Retrieve an Asset or Live Stream ID
51
+ data, status_code, headers = api_instance.get_asset_or_livestream_id_with_http_info(playback_id)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <GetAssetOrLiveStreamIdResponse>
55
+ rescue MuxRuby::ApiError => e
56
+ puts "Error when calling PlaybackIDApi->get_asset_or_livestream_id_with_http_info: #{e}"
37
57
  end
38
58
  ```
39
59
 
40
60
  ### Parameters
41
61
 
42
- Name | Type | Description | Notes
43
- ------------- | ------------- | ------------- | -------------
44
- **playback_id** | **String**| The live stream&#39;s playback ID. |
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **playback_id** | **String** | The live stream&#39;s playback ID. | |
45
65
 
46
66
  ### Return type
47
67
 
@@ -53,8 +73,6 @@ Name | Type | Description | Notes
53
73
 
54
74
  ### HTTP request headers
55
75
 
56
- - **Content-Type**: Not defined
57
- - **Accept**: application/json
58
-
59
-
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
60
78
 
@@ -1,7 +1,15 @@
1
1
  # MuxRuby::PlaybackPolicy
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::PlaybackPolicy.new()
14
+ ```
7
15
 
data/docs/RealTimeApi.md CHANGED
@@ -2,25 +2,27 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_realtime_breakdown**](RealTimeApi.md#get_realtime_breakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown
8
- [**get_realtime_histogram_timeseries**](RealTimeApi.md#get_realtime_histogram_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries
9
- [**get_realtime_timeseries**](RealTimeApi.md#get_realtime_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries
10
- [**list_realtime_dimensions**](RealTimeApi.md#list_realtime_dimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions
11
- [**list_realtime_metrics**](RealTimeApi.md#list_realtime_metrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_realtime_breakdown**](RealTimeApi.md#get_realtime_breakdown) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown | Get Real-Time Breakdown |
8
+ | [**get_realtime_histogram_timeseries**](RealTimeApi.md#get_realtime_histogram_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries | Get Real-Time Histogram Timeseries |
9
+ | [**get_realtime_timeseries**](RealTimeApi.md#get_realtime_timeseries) | **GET** /data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries | Get Real-Time Timeseries |
10
+ | [**list_realtime_dimensions**](RealTimeApi.md#list_realtime_dimensions) | **GET** /data/v1/realtime/dimensions | List Real-Time Dimensions |
11
+ | [**list_realtime_metrics**](RealTimeApi.md#list_realtime_metrics) | **GET** /data/v1/realtime/metrics | List Real-Time Metrics |
12
12
 
13
13
 
14
- # **get_realtime_breakdown**
15
- > GetRealTimeBreakdownResponse get_realtime_breakdown(realtime_metric_id, opts)
14
+ ## get_realtime_breakdown
15
+
16
+ > <GetRealTimeBreakdownResponse> get_realtime_breakdown(realtime_metric_id, opts)
16
17
 
17
18
  Get Real-Time Breakdown
18
19
 
19
20
  Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
20
21
 
21
- ### Example
22
+ ### Examples
23
+
22
24
  ```ruby
23
- # load the gem
25
+ require 'time'
24
26
  require 'mux_ruby'
25
27
  # setup authorization
26
28
  MuxRuby.configure do |config|
@@ -30,34 +32,52 @@ MuxRuby.configure do |config|
30
32
  end
31
33
 
32
34
  api_instance = MuxRuby::RealTimeApi.new
33
- realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
35
+ realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
34
36
  opts = {
35
- dimension: 'dimension_example', # String | Dimension the specified value belongs to
36
- timestamp: 3.4, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
37
- filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
38
- order_by: 'order_by_example', # String | Value to order the results by
39
- order_direction: 'order_direction_example' # String | Sort order.
37
+ dimension: 'asn', # String | Dimension the specified value belongs to
38
+ timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
39
+ filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
40
+ order_by: 'negative_impact', # String | Value to order the results by
41
+ order_direction: 'asc' # String | Sort order.
40
42
  }
41
43
 
42
44
  begin
43
- #Get Real-Time Breakdown
45
+ # Get Real-Time Breakdown
44
46
  result = api_instance.get_realtime_breakdown(realtime_metric_id, opts)
45
47
  p result
46
48
  rescue MuxRuby::ApiError => e
47
- puts "Exception when calling RealTimeApi->get_realtime_breakdown: #{e}"
49
+ puts "Error when calling RealTimeApi->get_realtime_breakdown: #{e}"
50
+ end
51
+ ```
52
+
53
+ #### Using the get_realtime_breakdown_with_http_info variant
54
+
55
+ This returns an Array which contains the response data, status code and headers.
56
+
57
+ > <Array(<GetRealTimeBreakdownResponse>, Integer, Hash)> get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
58
+
59
+ ```ruby
60
+ begin
61
+ # Get Real-Time Breakdown
62
+ data, status_code, headers = api_instance.get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
63
+ p status_code # => 2xx
64
+ p headers # => { ... }
65
+ p data # => <GetRealTimeBreakdownResponse>
66
+ rescue MuxRuby::ApiError => e
67
+ puts "Error when calling RealTimeApi->get_realtime_breakdown_with_http_info: #{e}"
48
68
  end
49
69
  ```
50
70
 
51
71
  ### Parameters
52
72
 
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **realtime_metric_id** | **String**| ID of the Realtime Metric |
56
- **dimension** | **String**| Dimension the specified value belongs to | [optional]
57
- **timestamp** | **Float**| Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional]
58
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
59
- **order_by** | **String**| Value to order the results by | [optional]
60
- **order_direction** | **String**| Sort order. | [optional]
73
+ | Name | Type | Description | Notes |
74
+ | ---- | ---- | ----------- | ----- |
75
+ | **realtime_metric_id** | **String** | ID of the Realtime Metric | |
76
+ | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
77
+ | **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
78
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
79
+ | **order_by** | **String** | Value to order the results by | [optional] |
80
+ | **order_direction** | **String** | Sort order. | [optional] |
61
81
 
62
82
  ### Return type
63
83
 
@@ -69,21 +89,22 @@ Name | Type | Description | Notes
69
89
 
70
90
  ### HTTP request headers
71
91
 
72
- - **Content-Type**: Not defined
73
- - **Accept**: application/json
92
+ - **Content-Type**: Not defined
93
+ - **Accept**: application/json
74
94
 
75
95
 
96
+ ## get_realtime_histogram_timeseries
76
97
 
77
- # **get_realtime_histogram_timeseries**
78
- > GetRealTimeHistogramTimeseriesResponse get_realtime_histogram_timeseries(realtime_metric_id, opts)
98
+ > <GetRealTimeHistogramTimeseriesResponse> get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts)
79
99
 
80
100
  Get Real-Time Histogram Timeseries
81
101
 
82
102
  Gets histogram timeseries information for a specific metric.
83
103
 
84
- ### Example
104
+ ### Examples
105
+
85
106
  ```ruby
86
- # load the gem
107
+ require 'time'
87
108
  require 'mux_ruby'
88
109
  # setup authorization
89
110
  MuxRuby.configure do |config|
@@ -93,26 +114,44 @@ MuxRuby.configure do |config|
93
114
  end
94
115
 
95
116
  api_instance = MuxRuby::RealTimeApi.new
96
- realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
117
+ realtime_histogram_metric_id = 'video-startup-time' # String | ID of the Realtime Histogram Metric
97
118
  opts = {
98
- filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
119
+ filters: ['inner_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
99
120
  }
100
121
 
101
122
  begin
102
- #Get Real-Time Histogram Timeseries
103
- result = api_instance.get_realtime_histogram_timeseries(realtime_metric_id, opts)
123
+ # Get Real-Time Histogram Timeseries
124
+ result = api_instance.get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts)
104
125
  p result
105
126
  rescue MuxRuby::ApiError => e
106
- puts "Exception when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
127
+ puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries: #{e}"
128
+ end
129
+ ```
130
+
131
+ #### Using the get_realtime_histogram_timeseries_with_http_info variant
132
+
133
+ This returns an Array which contains the response data, status code and headers.
134
+
135
+ > <Array(<GetRealTimeHistogramTimeseriesResponse>, Integer, Hash)> get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
136
+
137
+ ```ruby
138
+ begin
139
+ # Get Real-Time Histogram Timeseries
140
+ data, status_code, headers = api_instance.get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
141
+ p status_code # => 2xx
142
+ p headers # => { ... }
143
+ p data # => <GetRealTimeHistogramTimeseriesResponse>
144
+ rescue MuxRuby::ApiError => e
145
+ puts "Error when calling RealTimeApi->get_realtime_histogram_timeseries_with_http_info: #{e}"
107
146
  end
108
147
  ```
109
148
 
110
149
  ### Parameters
111
150
 
112
- Name | Type | Description | Notes
113
- ------------- | ------------- | ------------- | -------------
114
- **realtime_metric_id** | **String**| ID of the Realtime Metric |
115
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
151
+ | Name | Type | Description | Notes |
152
+ | ---- | ---- | ----------- | ----- |
153
+ | **realtime_histogram_metric_id** | **String** | ID of the Realtime Histogram Metric | |
154
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
116
155
 
117
156
  ### Return type
118
157
 
@@ -124,21 +163,22 @@ Name | Type | Description | Notes
124
163
 
125
164
  ### HTTP request headers
126
165
 
127
- - **Content-Type**: Not defined
128
- - **Accept**: application/json
166
+ - **Content-Type**: Not defined
167
+ - **Accept**: application/json
129
168
 
130
169
 
170
+ ## get_realtime_timeseries
131
171
 
132
- # **get_realtime_timeseries**
133
- > GetRealTimeTimeseriesResponse get_realtime_timeseries(realtime_metric_id, opts)
172
+ > <GetRealTimeTimeseriesResponse> get_realtime_timeseries(realtime_metric_id, opts)
134
173
 
135
174
  Get Real-Time Timeseries
136
175
 
137
176
  Gets Time series information for a specific metric along with the number of concurrent viewers.
138
177
 
139
- ### Example
178
+ ### Examples
179
+
140
180
  ```ruby
141
- # load the gem
181
+ require 'time'
142
182
  require 'mux_ruby'
143
183
  # setup authorization
144
184
  MuxRuby.configure do |config|
@@ -148,26 +188,44 @@ MuxRuby.configure do |config|
148
188
  end
149
189
 
150
190
  api_instance = MuxRuby::RealTimeApi.new
151
- realtime_metric_id = 'video-startup-time' # String | ID of the Realtime Metric
191
+ realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
152
192
  opts = {
153
- filters: ['filters_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
193
+ filters: ['inner_example'] # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
154
194
  }
155
195
 
156
196
  begin
157
- #Get Real-Time Timeseries
197
+ # Get Real-Time Timeseries
158
198
  result = api_instance.get_realtime_timeseries(realtime_metric_id, opts)
159
199
  p result
160
200
  rescue MuxRuby::ApiError => e
161
- puts "Exception when calling RealTimeApi->get_realtime_timeseries: #{e}"
201
+ puts "Error when calling RealTimeApi->get_realtime_timeseries: #{e}"
202
+ end
203
+ ```
204
+
205
+ #### Using the get_realtime_timeseries_with_http_info variant
206
+
207
+ This returns an Array which contains the response data, status code and headers.
208
+
209
+ > <Array(<GetRealTimeTimeseriesResponse>, Integer, Hash)> get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
210
+
211
+ ```ruby
212
+ begin
213
+ # Get Real-Time Timeseries
214
+ data, status_code, headers = api_instance.get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
215
+ p status_code # => 2xx
216
+ p headers # => { ... }
217
+ p data # => <GetRealTimeTimeseriesResponse>
218
+ rescue MuxRuby::ApiError => e
219
+ puts "Error when calling RealTimeApi->get_realtime_timeseries_with_http_info: #{e}"
162
220
  end
163
221
  ```
164
222
 
165
223
  ### Parameters
166
224
 
167
- Name | Type | Description | Notes
168
- ------------- | ------------- | ------------- | -------------
169
- **realtime_metric_id** | **String**| ID of the Realtime Metric |
170
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional]
225
+ | Name | Type | Description | Notes |
226
+ | ---- | ---- | ----------- | ----- |
227
+ | **realtime_metric_id** | **String** | ID of the Realtime Metric | |
228
+ | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
171
229
 
172
230
  ### Return type
173
231
 
@@ -179,21 +237,22 @@ Name | Type | Description | Notes
179
237
 
180
238
  ### HTTP request headers
181
239
 
182
- - **Content-Type**: Not defined
183
- - **Accept**: application/json
240
+ - **Content-Type**: Not defined
241
+ - **Accept**: application/json
184
242
 
185
243
 
244
+ ## list_realtime_dimensions
186
245
 
187
- # **list_realtime_dimensions**
188
- > ListRealTimeDimensionsResponse list_realtime_dimensions
246
+ > <ListRealTimeDimensionsResponse> list_realtime_dimensions
189
247
 
190
248
  List Real-Time Dimensions
191
249
 
192
250
  Lists availiable real-time dimensions
193
251
 
194
- ### Example
252
+ ### Examples
253
+
195
254
  ```ruby
196
- # load the gem
255
+ require 'time'
197
256
  require 'mux_ruby'
198
257
  # setup authorization
199
258
  MuxRuby.configure do |config|
@@ -205,15 +264,34 @@ end
205
264
  api_instance = MuxRuby::RealTimeApi.new
206
265
 
207
266
  begin
208
- #List Real-Time Dimensions
267
+ # List Real-Time Dimensions
209
268
  result = api_instance.list_realtime_dimensions
210
269
  p result
211
270
  rescue MuxRuby::ApiError => e
212
- puts "Exception when calling RealTimeApi->list_realtime_dimensions: #{e}"
271
+ puts "Error when calling RealTimeApi->list_realtime_dimensions: #{e}"
272
+ end
273
+ ```
274
+
275
+ #### Using the list_realtime_dimensions_with_http_info variant
276
+
277
+ This returns an Array which contains the response data, status code and headers.
278
+
279
+ > <Array(<ListRealTimeDimensionsResponse>, Integer, Hash)> list_realtime_dimensions_with_http_info
280
+
281
+ ```ruby
282
+ begin
283
+ # List Real-Time Dimensions
284
+ data, status_code, headers = api_instance.list_realtime_dimensions_with_http_info
285
+ p status_code # => 2xx
286
+ p headers # => { ... }
287
+ p data # => <ListRealTimeDimensionsResponse>
288
+ rescue MuxRuby::ApiError => e
289
+ puts "Error when calling RealTimeApi->list_realtime_dimensions_with_http_info: #{e}"
213
290
  end
214
291
  ```
215
292
 
216
293
  ### Parameters
294
+
217
295
  This endpoint does not need any parameter.
218
296
 
219
297
  ### Return type
@@ -226,21 +304,22 @@ This endpoint does not need any parameter.
226
304
 
227
305
  ### HTTP request headers
228
306
 
229
- - **Content-Type**: Not defined
230
- - **Accept**: application/json
307
+ - **Content-Type**: Not defined
308
+ - **Accept**: application/json
231
309
 
232
310
 
311
+ ## list_realtime_metrics
233
312
 
234
- # **list_realtime_metrics**
235
- > ListRealTimeMetricsResponse list_realtime_metrics
313
+ > <ListRealTimeMetricsResponse> list_realtime_metrics
236
314
 
237
315
  List Real-Time Metrics
238
316
 
239
317
  Lists availiable real-time metrics.
240
318
 
241
- ### Example
319
+ ### Examples
320
+
242
321
  ```ruby
243
- # load the gem
322
+ require 'time'
244
323
  require 'mux_ruby'
245
324
  # setup authorization
246
325
  MuxRuby.configure do |config|
@@ -252,15 +331,34 @@ end
252
331
  api_instance = MuxRuby::RealTimeApi.new
253
332
 
254
333
  begin
255
- #List Real-Time Metrics
334
+ # List Real-Time Metrics
256
335
  result = api_instance.list_realtime_metrics
257
336
  p result
258
337
  rescue MuxRuby::ApiError => e
259
- puts "Exception when calling RealTimeApi->list_realtime_metrics: #{e}"
338
+ puts "Error when calling RealTimeApi->list_realtime_metrics: #{e}"
339
+ end
340
+ ```
341
+
342
+ #### Using the list_realtime_metrics_with_http_info variant
343
+
344
+ This returns an Array which contains the response data, status code and headers.
345
+
346
+ > <Array(<ListRealTimeMetricsResponse>, Integer, Hash)> list_realtime_metrics_with_http_info
347
+
348
+ ```ruby
349
+ begin
350
+ # List Real-Time Metrics
351
+ data, status_code, headers = api_instance.list_realtime_metrics_with_http_info
352
+ p status_code # => 2xx
353
+ p headers # => { ... }
354
+ p data # => <ListRealTimeMetricsResponse>
355
+ rescue MuxRuby::ApiError => e
356
+ puts "Error when calling RealTimeApi->list_realtime_metrics_with_http_info: #{e}"
260
357
  end
261
358
  ```
262
359
 
263
360
  ### Parameters
361
+
264
362
  This endpoint does not need any parameter.
265
363
 
266
364
  ### Return type
@@ -273,8 +371,6 @@ This endpoint does not need any parameter.
273
371
 
274
372
  ### HTTP request headers
275
373
 
276
- - **Content-Type**: Not defined
277
- - **Accept**: application/json
278
-
279
-
374
+ - **Content-Type**: Not defined
375
+ - **Accept**: application/json
280
376