mux_ruby 1.8.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (288) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +26 -37
  4. data/README.md +37 -13
  5. data/docs/AbridgedVideoView.md +33 -13
  6. data/docs/Asset.md +59 -25
  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 +396 -161
  15. data/docs/BreakdownValue.md +21 -7
  16. data/docs/CreateAssetRequest.md +27 -10
  17. data/docs/CreateLiveStreamRequest.md +27 -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 +41 -23
  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 +38 -20
  33. data/docs/ExportDate.md +20 -0
  34. data/docs/ExportFile.md +22 -0
  35. data/docs/ExportsApi.md +99 -12
  36. data/docs/FilterValue.md +15 -4
  37. data/docs/FiltersApi.md +71 -33
  38. data/docs/GetAssetInputInfoResponse.md +13 -3
  39. data/docs/GetAssetOrLiveStreamIdResponse.md +18 -0
  40. data/docs/GetAssetOrLiveStreamIdResponseData.md +22 -0
  41. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +20 -0
  42. data/docs/GetAssetPlaybackIDResponse.md +13 -3
  43. data/docs/GetMetricTimeseriesDataResponse.md +17 -5
  44. data/docs/GetOverallValuesResponse.md +17 -5
  45. data/docs/GetRealTimeBreakdownResponse.md +17 -5
  46. data/docs/GetRealTimeHistogramTimeseriesResponse.md +19 -6
  47. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +13 -3
  48. data/docs/GetRealTimeTimeseriesResponse.md +17 -5
  49. data/docs/Incident.md +53 -23
  50. data/docs/IncidentBreakdown.md +17 -5
  51. data/docs/IncidentNotification.md +17 -5
  52. data/docs/IncidentNotificationRule.md +21 -7
  53. data/docs/IncidentResponse.md +15 -4
  54. data/docs/IncidentsApi.md +118 -62
  55. data/docs/InputFile.md +15 -4
  56. data/docs/InputInfo.md +15 -4
  57. data/docs/InputSettings.md +31 -10
  58. data/docs/InputSettingsOverlaySettings.md +25 -9
  59. data/docs/InputTrack.md +29 -11
  60. data/docs/Insight.md +23 -8
  61. data/docs/ListAllMetricValuesResponse.md +17 -5
  62. data/docs/ListAssetsResponse.md +13 -3
  63. data/docs/ListBreakdownValuesResponse.md +17 -5
  64. data/docs/ListDeliveryUsageResponse.md +19 -6
  65. data/docs/ListDimensionValuesResponse.md +17 -5
  66. data/docs/ListDimensionsResponse.md +17 -5
  67. data/docs/ListErrorsResponse.md +17 -5
  68. data/docs/ListExportsResponse.md +17 -5
  69. data/docs/ListFilterValuesResponse.md +17 -5
  70. data/docs/ListFiltersResponse.md +17 -5
  71. data/docs/ListFiltersResponseData.md +15 -4
  72. data/docs/ListIncidentsResponse.md +17 -5
  73. data/docs/ListInsightsResponse.md +17 -5
  74. data/docs/ListLiveStreamsResponse.md +13 -3
  75. data/docs/ListRealTimeDimensionsResponse.md +17 -5
  76. data/docs/ListRealTimeDimensionsResponseData.md +15 -4
  77. data/docs/ListRealTimeMetricsResponse.md +17 -5
  78. data/docs/ListRelatedIncidentsResponse.md +17 -5
  79. data/docs/ListSigningKeysResponse.md +13 -3
  80. data/docs/ListUploadsResponse.md +13 -3
  81. data/docs/ListVideoViewExportsResponse.md +22 -0
  82. data/docs/ListVideoViewsResponse.md +17 -5
  83. data/docs/LiveStream.md +39 -15
  84. data/docs/LiveStreamResponse.md +13 -3
  85. data/docs/LiveStreamsApi.md +418 -170
  86. data/docs/Metric.md +21 -7
  87. data/docs/MetricsApi.md +211 -117
  88. data/docs/NotificationRule.md +17 -5
  89. data/docs/OverallValues.md +19 -6
  90. data/docs/PlaybackID.md +15 -4
  91. data/docs/PlaybackIDApi.md +78 -0
  92. data/docs/PlaybackPolicy.md +10 -2
  93. data/docs/RealTimeApi.md +177 -81
  94. data/docs/RealTimeBreakdownValue.md +21 -7
  95. data/docs/RealTimeHistogramTimeseriesBucket.md +15 -4
  96. data/docs/RealTimeHistogramTimeseriesBucketValues.md +15 -4
  97. data/docs/RealTimeHistogramTimeseriesDatapoint.md +25 -9
  98. data/docs/RealTimeTimeseriesDatapoint.md +17 -5
  99. data/docs/Score.md +23 -8
  100. data/docs/SignalLiveStreamCompleteResponse.md +13 -3
  101. data/docs/SigningKey.md +17 -5
  102. data/docs/SigningKeyResponse.md +13 -3
  103. data/docs/SimulcastTarget.md +21 -7
  104. data/docs/SimulcastTargetResponse.md +13 -3
  105. data/docs/Track.md +37 -15
  106. data/docs/URLSigningKeysApi.md +130 -54
  107. data/docs/UpdateAssetMP4SupportRequest.md +13 -3
  108. data/docs/UpdateAssetMasterAccessRequest.md +13 -3
  109. data/docs/Upload.md +29 -11
  110. data/docs/UploadError.md +15 -4
  111. data/docs/UploadResponse.md +13 -3
  112. data/docs/VideoView.md +251 -114
  113. data/docs/VideoViewEvent.md +19 -6
  114. data/docs/VideoViewResponse.md +15 -4
  115. data/docs/VideoViewsApi.md +78 -41
  116. data/examples/video/exercise-assets.rb +21 -0
  117. data/examples/video/exercise-live-streams.rb +8 -0
  118. data/gen/.gitignore +7 -0
  119. data/gen/Makefile +31 -0
  120. data/gen/generator-config.json +11 -0
  121. data/gen/openapitools.json +7 -0
  122. data/gen/package.json +17 -0
  123. data/gen/templates/Gemfile.mustache +11 -0
  124. data/gen/templates/README.mustache +158 -0
  125. data/gen/templates/Rakefile.mustache +10 -0
  126. data/gen/templates/api.mustache +206 -0
  127. data/gen/templates/api_client.mustache +264 -0
  128. data/gen/templates/api_client_faraday_partial.mustache +138 -0
  129. data/gen/templates/api_client_spec.mustache +220 -0
  130. data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
  131. data/gen/templates/api_doc.mustache +118 -0
  132. data/gen/templates/api_error.mustache +67 -0
  133. data/gen/templates/api_info.mustache +12 -0
  134. data/gen/templates/api_test.mustache +47 -0
  135. data/gen/templates/base_object.mustache +120 -0
  136. data/gen/templates/configuration.mustache +349 -0
  137. data/gen/templates/configuration_spec.mustache +34 -0
  138. data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
  139. data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  140. data/gen/templates/gem.mustache +40 -0
  141. data/gen/templates/gemspec.mustache +35 -0
  142. data/gen/templates/gitignore.mustache +39 -0
  143. data/gen/templates/model.mustache +26 -0
  144. data/gen/templates/model_doc.mustache +12 -0
  145. data/gen/templates/model_test.mustache +77 -0
  146. data/gen/templates/partial_model_enum_class.mustache +20 -0
  147. data/gen/templates/partial_model_generic.mustache +371 -0
  148. data/gen/templates/partial_model_generic_doc.mustache +28 -0
  149. data/gen/templates/partial_oneof_module.mustache +137 -0
  150. data/gen/templates/partial_oneof_module_doc.mustache +92 -0
  151. data/gen/templates/rspec.mustache +2 -0
  152. data/gen/templates/rubocop.mustache +148 -0
  153. data/gen/templates/spec_helper.mustache +103 -0
  154. data/gen/templates/version.mustache +7 -0
  155. data/gen/yarn.lock +1878 -0
  156. data/lib/mux_ruby.rb +16 -2
  157. data/lib/mux_ruby/api/assets_api.rb +291 -152
  158. data/lib/mux_ruby/api/delivery_usage_api.rb +32 -16
  159. data/lib/mux_ruby/api/dimensions_api.rb +55 -29
  160. data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
  161. data/lib/mux_ruby/api/errors_api.rb +34 -18
  162. data/lib/mux_ruby/api/exports_api.rb +86 -13
  163. data/lib/mux_ruby/api/filters_api.rb +53 -27
  164. data/lib/mux_ruby/api/incidents_api.rb +94 -52
  165. data/lib/mux_ruby/api/live_streams_api.rb +299 -157
  166. data/lib/mux_ruby/api/metrics_api.rb +193 -122
  167. data/lib/mux_ruby/api/playback_id_api.rb +85 -0
  168. data/lib/mux_ruby/api/real_time_api.rb +149 -87
  169. data/lib/mux_ruby/api/url_signing_keys_api.rb +95 -48
  170. data/lib/mux_ruby/api/video_views_api.rb +60 -33
  171. data/lib/mux_ruby/api_client.rb +106 -91
  172. data/lib/mux_ruby/api_error.rb +35 -7
  173. data/lib/mux_ruby/configuration.rb +50 -14
  174. data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
  175. data/lib/mux_ruby/models/asset.rb +129 -58
  176. data/lib/mux_ruby/models/asset_errors.rb +52 -15
  177. data/lib/mux_ruby/models/asset_master.rb +85 -15
  178. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +78 -43
  179. data/lib/mux_ruby/models/asset_recording_times.rb +52 -18
  180. data/lib/mux_ruby/models/asset_response.rb +48 -14
  181. data/lib/mux_ruby/models/asset_static_renditions.rb +55 -19
  182. data/lib/mux_ruby/models/asset_static_renditions_files.rb +60 -25
  183. data/lib/mux_ruby/models/breakdown_value.rb +52 -18
  184. data/lib/mux_ruby/models/create_asset_request.rb +70 -30
  185. data/lib/mux_ruby/models/create_live_stream_request.rb +68 -23
  186. data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
  187. data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
  188. data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
  189. data/lib/mux_ruby/models/create_track_request.rb +65 -27
  190. data/lib/mux_ruby/models/create_track_response.rb +48 -14
  191. data/lib/mux_ruby/models/create_upload_request.rb +52 -18
  192. data/lib/mux_ruby/models/delivery_report.rb +106 -21
  193. data/lib/mux_ruby/models/dimension_value.rb +49 -15
  194. data/lib/mux_ruby/models/disable_live_stream_response.rb +48 -14
  195. data/lib/mux_ruby/models/enable_live_stream_response.rb +48 -14
  196. data/lib/mux_ruby/models/error.rb +63 -21
  197. data/lib/mux_ruby/models/export_date.rb +229 -0
  198. data/lib/mux_ruby/models/export_file.rb +236 -0
  199. data/lib/mux_ruby/models/filter_value.rb +49 -15
  200. data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
  201. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +218 -0
  202. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +237 -0
  203. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +264 -0
  204. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
  205. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
  206. data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
  207. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +50 -16
  208. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +51 -17
  209. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +48 -14
  210. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +50 -16
  211. data/lib/mux_ruby/models/incident.rb +68 -34
  212. data/lib/mux_ruby/models/incident_breakdown.rb +50 -16
  213. data/lib/mux_ruby/models/incident_notification.rb +50 -16
  214. data/lib/mux_ruby/models/incident_notification_rule.rb +52 -18
  215. data/lib/mux_ruby/models/incident_response.rb +49 -15
  216. data/lib/mux_ruby/models/input_file.rb +49 -15
  217. data/lib/mux_ruby/models/input_info.rb +49 -15
  218. data/lib/mux_ruby/models/input_settings.rb +91 -30
  219. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +68 -26
  220. data/lib/mux_ruby/models/input_track.rb +56 -22
  221. data/lib/mux_ruby/models/insight.rb +53 -19
  222. data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
  223. data/lib/mux_ruby/models/list_assets_response.rb +48 -14
  224. data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
  225. data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
  226. data/lib/mux_ruby/models/list_dimension_values_response.rb +50 -16
  227. data/lib/mux_ruby/models/list_dimensions_response.rb +50 -16
  228. data/lib/mux_ruby/models/list_errors_response.rb +50 -16
  229. data/lib/mux_ruby/models/list_exports_response.rb +50 -16
  230. data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
  231. data/lib/mux_ruby/models/list_filters_response.rb +50 -16
  232. data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
  233. data/lib/mux_ruby/models/list_incidents_response.rb +50 -16
  234. data/lib/mux_ruby/models/list_insights_response.rb +50 -16
  235. data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
  236. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +50 -16
  237. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +49 -15
  238. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +50 -16
  239. data/lib/mux_ruby/models/list_related_incidents_response.rb +50 -16
  240. data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
  241. data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
  242. data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
  243. data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
  244. data/lib/mux_ruby/models/live_stream.rb +121 -29
  245. data/lib/mux_ruby/models/live_stream_response.rb +48 -14
  246. data/lib/mux_ruby/models/metric.rb +52 -18
  247. data/lib/mux_ruby/models/notification_rule.rb +50 -16
  248. data/lib/mux_ruby/models/overall_values.rb +51 -17
  249. data/lib/mux_ruby/models/playback_id.rb +50 -15
  250. data/lib/mux_ruby/models/playback_policy.rb +12 -6
  251. data/lib/mux_ruby/models/real_time_breakdown_value.rb +52 -18
  252. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +50 -16
  253. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +49 -15
  254. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +54 -20
  255. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +50 -16
  256. data/lib/mux_ruby/models/score.rb +53 -19
  257. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
  258. data/lib/mux_ruby/models/signing_key.rb +53 -16
  259. data/lib/mux_ruby/models/signing_key_response.rb +48 -14
  260. data/lib/mux_ruby/models/simulcast_target.rb +55 -21
  261. data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
  262. data/lib/mux_ruby/models/track.rb +92 -33
  263. data/lib/mux_ruby/models/update_asset_master_access_request.rb +51 -17
  264. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +51 -17
  265. data/lib/mux_ruby/models/upload.rb +62 -26
  266. data/lib/mux_ruby/models/upload_error.rb +51 -15
  267. data/lib/mux_ruby/models/upload_response.rb +48 -14
  268. data/lib/mux_ruby/models/video_view.rb +242 -136
  269. data/lib/mux_ruby/models/video_view_event.rb +51 -17
  270. data/lib/mux_ruby/models/video_view_response.rb +49 -15
  271. data/lib/mux_ruby/version.rb +10 -3
  272. data/mux_ruby.gemspec +15 -15
  273. data/spec/api/assets_api_spec.rb +2 -0
  274. data/spec/api/playback_id_api_spec.rb +40 -0
  275. data/spec/api_client_spec.rb +10 -3
  276. data/spec/configuration_spec.rb +9 -2
  277. data/spec/models/asset_master_spec.rb +4 -0
  278. data/spec/models/asset_spec.rb +10 -0
  279. data/spec/models/export_date_spec.rb +40 -0
  280. data/spec/models/export_file_spec.rb +46 -0
  281. data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
  282. data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
  283. data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
  284. data/spec/models/input_settings_spec.rb +12 -0
  285. data/spec/models/list_video_view_exports_response_spec.rb +46 -0
  286. data/spec/models/track_spec.rb +4 -0
  287. data/spec/spec_helper.rb +9 -2
  288. metadata +161 -235
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::GetAssetInputInfoResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Array<InputInfo>**](InputInfo.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<InputInfo>**](InputInfo.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::GetAssetInputInfoResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
@@ -0,0 +1,18 @@
1
+ # MuxRuby::GetAssetOrLiveStreamIdResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**GetAssetOrLiveStreamIdResponseData**](GetAssetOrLiveStreamIdResponseData.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::GetAssetOrLiveStreamIdResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # MuxRuby::GetAssetOrLiveStreamIdResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The Playback ID used to retrieve the corresponding asset or the live stream ID | [optional] |
8
+ | **policy** | [**PlaybackPolicy**](PlaybackPolicy.md) | | [optional] |
9
+ | **object** | [**GetAssetOrLiveStreamIdResponseDataObject**](GetAssetOrLiveStreamIdResponseDataObject.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetAssetOrLiveStreamIdResponseData.new(
17
+ id: null,
18
+ policy: null,
19
+ object: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # MuxRuby::GetAssetOrLiveStreamIdResponseDataObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The identifier of the object. | [optional] |
8
+ | **type** | **String** | Identifies the object type associated with the playback ID. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::GetAssetOrLiveStreamIdResponseDataObject.new(
16
+ id: null,
17
+ type: null
18
+ )
19
+ ```
20
+
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::GetAssetPlaybackIDResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**PlaybackID**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**PlaybackID**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::GetAssetPlaybackIDResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::GetMetricTimeseriesDataResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | **Array<Array<String>>** | | [optional]
7
- **total_row_count** | **Integer** | | [optional]
8
- **timeframe** | **Array<Integer>** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Array<Array<String>>** | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array<Integer>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetMetricTimeseriesDataResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
10
22
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::GetOverallValuesResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**OverallValues**](OverallValues.md) | | [optional]
7
- **total_row_count** | **Integer** | | [optional]
8
- **timeframe** | **Array<Integer>** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**OverallValues**](OverallValues.md) | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array<Integer>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetOverallValuesResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
10
22
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::GetRealTimeBreakdownResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Array<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) | | [optional]
7
- **total_row_count** | **Integer** | | [optional]
8
- **timeframe** | **Array<Integer>** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array<Integer>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetRealTimeBreakdownResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
10
22
 
@@ -1,11 +1,24 @@
1
1
  # MuxRuby::GetRealTimeHistogramTimeseriesResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional]
7
- **data** | [**Array<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional]
8
- **total_row_count** | **Integer** | | [optional]
9
- **timeframe** | **Array<Integer>** | | [optional]
10
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional] |
8
+ | **data** | [**Array<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional] |
9
+ | **total_row_count** | **Integer** | | [optional] |
10
+ | **timeframe** | **Array<Integer>** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mux_ruby'
16
+
17
+ instance = MuxRuby::GetRealTimeHistogramTimeseriesResponse.new(
18
+ meta: null,
19
+ data: null,
20
+ total_row_count: null,
21
+ timeframe: null
22
+ )
23
+ ```
11
24
 
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta.new(
15
+ buckets: null
16
+ )
17
+ ```
8
18
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::GetRealTimeTimeseriesResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Array<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) | | [optional]
7
- **total_row_count** | **Integer** | | [optional]
8
- **timeframe** | **Array<Integer>** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array<Integer>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::GetRealTimeTimeseriesResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
10
22
 
data/docs/Incident.md CHANGED
@@ -1,28 +1,58 @@
1
1
  # MuxRuby::Incident
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **threshold** | **Float** | | [optional]
7
- **status** | **String** | | [optional]
8
- **started_at** | **String** | | [optional]
9
- **severity** | **String** | | [optional]
10
- **sample_size_unit** | **String** | | [optional]
11
- **sample_size** | **Integer** | | [optional]
12
- **resolved_at** | **String** | | [optional]
13
- **notifications** | [**Array<IncidentNotification>**](IncidentNotification.md) | | [optional]
14
- **notification_rules** | [**Array<IncidentNotificationRule>**](IncidentNotificationRule.md) | | [optional]
15
- **measurement** | **String** | | [optional]
16
- **measured_value_on_close** | **Float** | | [optional]
17
- **measured_value** | **Float** | | [optional]
18
- **incident_key** | **String** | | [optional]
19
- **impact** | **String** | | [optional]
20
- **id** | **String** | | [optional]
21
- **error_description** | **String** | | [optional]
22
- **description** | **String** | | [optional]
23
- **breakdowns** | [**Array<IncidentBreakdown>**](IncidentBreakdown.md) | | [optional]
24
- **affected_views_per_hour_on_open** | **Integer** | | [optional]
25
- **affected_views_per_hour** | **Integer** | | [optional]
26
- **affected_views** | **Integer** | | [optional]
27
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **threshold** | **Float** | | [optional] |
8
+ | **status** | **String** | | [optional] |
9
+ | **started_at** | **String** | | [optional] |
10
+ | **severity** | **String** | | [optional] |
11
+ | **sample_size_unit** | **String** | | [optional] |
12
+ | **sample_size** | **Integer** | | [optional] |
13
+ | **resolved_at** | **String** | | [optional] |
14
+ | **notifications** | [**Array<IncidentNotification>**](IncidentNotification.md) | | [optional] |
15
+ | **notification_rules** | [**Array<IncidentNotificationRule>**](IncidentNotificationRule.md) | | [optional] |
16
+ | **measurement** | **String** | | [optional] |
17
+ | **measured_value_on_close** | **Float** | | [optional] |
18
+ | **measured_value** | **Float** | | [optional] |
19
+ | **incident_key** | **String** | | [optional] |
20
+ | **impact** | **String** | | [optional] |
21
+ | **id** | **String** | | [optional] |
22
+ | **error_description** | **String** | | [optional] |
23
+ | **description** | **String** | | [optional] |
24
+ | **breakdowns** | [**Array<IncidentBreakdown>**](IncidentBreakdown.md) | | [optional] |
25
+ | **affected_views_per_hour_on_open** | **Integer** | | [optional] |
26
+ | **affected_views_per_hour** | **Integer** | | [optional] |
27
+ | **affected_views** | **Integer** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'mux_ruby'
33
+
34
+ instance = MuxRuby::Incident.new(
35
+ threshold: null,
36
+ status: null,
37
+ started_at: null,
38
+ severity: null,
39
+ sample_size_unit: null,
40
+ sample_size: null,
41
+ resolved_at: null,
42
+ notifications: null,
43
+ notification_rules: null,
44
+ measurement: null,
45
+ measured_value_on_close: null,
46
+ measured_value: null,
47
+ incident_key: null,
48
+ impact: null,
49
+ id: null,
50
+ error_description: null,
51
+ description: null,
52
+ breakdowns: null,
53
+ affected_views_per_hour_on_open: null,
54
+ affected_views_per_hour: null,
55
+ affected_views: null
56
+ )
57
+ ```
28
58
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::IncidentBreakdown
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::IncidentBreakdown.new(
17
+ value: null,
18
+ name: null,
19
+ id: null
20
+ )
21
+ ```
10
22
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::IncidentNotification
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **queued_at** | **String** | | [optional]
7
- **id** | **Integer** | | [optional]
8
- **attempted_at** | **String** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **queued_at** | **String** | | [optional] |
8
+ | **id** | **Integer** | | [optional] |
9
+ | **attempted_at** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::IncidentNotification.new(
17
+ queued_at: null,
18
+ id: null,
19
+ attempted_at: null
20
+ )
21
+ ```
10
22
 
@@ -1,12 +1,26 @@
1
1
  # MuxRuby::IncidentNotificationRule
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **status** | **String** | | [optional]
7
- **rules** | [**Array<NotificationRule>**](NotificationRule.md) | | [optional]
8
- **property_id** | **String** | | [optional]
9
- **id** | **String** | | [optional]
10
- **action** | **String** | | [optional]
11
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional] |
8
+ | **rules** | [**Array<NotificationRule>**](NotificationRule.md) | | [optional] |
9
+ | **property_id** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **action** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mux_ruby'
17
+
18
+ instance = MuxRuby::IncidentNotificationRule.new(
19
+ status: null,
20
+ rules: null,
21
+ property_id: null,
22
+ id: null,
23
+ action: null
24
+ )
25
+ ```
12
26