mux_ruby 1.6.0 → 2.0.0.pre.rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (314) 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 -23
  7. data/docs/AssetErrors.md +15 -4
  8. data/docs/AssetMaster.md +15 -4
  9. data/docs/AssetNonStandardInputReasons.md +34 -0
  10. data/docs/AssetRecordingTimes.md +20 -0
  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 +20 -0
  27. data/docs/DimensionsApi.md +156 -0
  28. data/docs/DirectUploadsApi.md +131 -56
  29. data/docs/DisableLiveStreamResponse.md +18 -0
  30. data/docs/EnableLiveStreamResponse.md +18 -0
  31. data/docs/Error.md +27 -10
  32. data/docs/ErrorsApi.md +38 -20
  33. data/docs/ExportsApi.md +33 -14
  34. data/docs/FilterValue.md +15 -4
  35. data/docs/FiltersApi.md +73 -35
  36. data/docs/GetAssetInputInfoResponse.md +13 -3
  37. data/docs/GetAssetOrLiveStreamIdResponse.md +18 -0
  38. data/docs/GetAssetOrLiveStreamIdResponseData.md +22 -0
  39. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +20 -0
  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 +22 -0
  44. data/docs/GetRealTimeHistogramTimeseriesResponse.md +24 -0
  45. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +18 -0
  46. data/docs/GetRealTimeTimeseriesResponse.md +22 -0
  47. data/docs/Incident.md +58 -0
  48. data/docs/IncidentBreakdown.md +22 -0
  49. data/docs/IncidentNotification.md +22 -0
  50. data/docs/IncidentNotificationRule.md +26 -0
  51. data/docs/IncidentResponse.md +20 -0
  52. data/docs/IncidentsApi.md +242 -0
  53. data/docs/InputFile.md +15 -4
  54. data/docs/InputInfo.md +15 -4
  55. data/docs/InputSettings.md +31 -10
  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 +22 -0
  64. data/docs/ListDimensionsResponse.md +22 -0
  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 +22 -0
  71. data/docs/ListInsightsResponse.md +17 -5
  72. data/docs/ListLiveStreamsResponse.md +13 -3
  73. data/docs/ListRealTimeDimensionsResponse.md +22 -0
  74. data/docs/ListRealTimeDimensionsResponseData.md +20 -0
  75. data/docs/ListRealTimeMetricsResponse.md +22 -0
  76. data/docs/ListRelatedIncidentsResponse.md +22 -0
  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 +39 -15
  81. data/docs/LiveStreamResponse.md +13 -3
  82. data/docs/LiveStreamsApi.md +497 -145
  83. data/docs/Metric.md +21 -7
  84. data/docs/MetricsApi.md +211 -117
  85. data/docs/NotificationRule.md +22 -0
  86. data/docs/OverallValues.md +19 -6
  87. data/docs/PlaybackID.md +15 -4
  88. data/docs/PlaybackIDApi.md +78 -0
  89. data/docs/PlaybackPolicy.md +10 -2
  90. data/docs/RealTimeApi.md +376 -0
  91. data/docs/RealTimeBreakdownValue.md +26 -0
  92. data/docs/RealTimeHistogramTimeseriesBucket.md +20 -0
  93. data/docs/RealTimeHistogramTimeseriesBucketValues.md +20 -0
  94. data/docs/RealTimeHistogramTimeseriesDatapoint.md +30 -0
  95. data/docs/RealTimeTimeseriesDatapoint.md +22 -0
  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 +130 -54
  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 +251 -114
  110. data/docs/VideoViewEvent.md +19 -6
  111. data/docs/VideoViewResponse.md +15 -4
  112. data/docs/VideoViewsApi.md +78 -41
  113. data/examples/data/exercise-dimensions.rb +29 -0
  114. data/examples/data/exercise-incidents.rb +29 -0
  115. data/examples/data/exercise-realtime.rb +60 -0
  116. data/examples/video/exercise-assets.rb +21 -0
  117. data/examples/video/exercise-live-streams.rb +30 -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 +43 -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 +154 -0
  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 +30 -14
  163. data/lib/mux_ruby/api/filters_api.rb +57 -31
  164. data/lib/mux_ruby/api/incidents_api.rb +259 -0
  165. data/lib/mux_ruby/api/live_streams_api.rb +381 -133
  166. data/lib/mux_ruby/api/metrics_api.rb +185 -114
  167. data/lib/mux_ruby/api/playback_id_api.rb +85 -0
  168. data/lib/mux_ruby/api/real_time_api.rb +373 -0
  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 +157 -53
  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 +370 -0
  179. data/lib/mux_ruby/models/asset_recording_times.rb +229 -0
  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 +227 -0
  194. data/lib/mux_ruby/models/disable_live_stream_response.rb +218 -0
  195. data/lib/mux_ruby/models/enable_live_stream_response.rb +218 -0
  196. data/lib/mux_ruby/models/error.rb +63 -21
  197. data/lib/mux_ruby/models/filter_value.rb +49 -15
  198. data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
  199. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +218 -0
  200. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +237 -0
  201. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +264 -0
  202. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
  203. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
  204. data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
  205. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +240 -0
  206. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +249 -0
  207. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +220 -0
  208. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +240 -0
  209. data/lib/mux_ruby/models/incident.rb +404 -0
  210. data/lib/mux_ruby/models/incident_breakdown.rb +236 -0
  211. data/lib/mux_ruby/models/incident_notification.rb +236 -0
  212. data/lib/mux_ruby/models/incident_notification_rule.rb +256 -0
  213. data/lib/mux_ruby/models/incident_response.rb +229 -0
  214. data/lib/mux_ruby/models/input_file.rb +49 -15
  215. data/lib/mux_ruby/models/input_info.rb +49 -15
  216. data/lib/mux_ruby/models/input_settings.rb +91 -30
  217. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +68 -26
  218. data/lib/mux_ruby/models/input_track.rb +56 -22
  219. data/lib/mux_ruby/models/insight.rb +53 -19
  220. data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
  221. data/lib/mux_ruby/models/list_assets_response.rb +48 -14
  222. data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
  223. data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
  224. data/lib/mux_ruby/models/list_dimension_values_response.rb +240 -0
  225. data/lib/mux_ruby/models/list_dimensions_response.rb +238 -0
  226. data/lib/mux_ruby/models/list_errors_response.rb +50 -16
  227. data/lib/mux_ruby/models/list_exports_response.rb +50 -16
  228. data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
  229. data/lib/mux_ruby/models/list_filters_response.rb +50 -16
  230. data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
  231. data/lib/mux_ruby/models/list_incidents_response.rb +240 -0
  232. data/lib/mux_ruby/models/list_insights_response.rb +50 -16
  233. data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
  234. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +240 -0
  235. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +227 -0
  236. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +240 -0
  237. data/lib/mux_ruby/models/list_related_incidents_response.rb +240 -0
  238. data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
  239. data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
  240. data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
  241. data/lib/mux_ruby/models/live_stream.rb +121 -29
  242. data/lib/mux_ruby/models/live_stream_response.rb +48 -14
  243. data/lib/mux_ruby/models/metric.rb +52 -18
  244. data/lib/mux_ruby/models/notification_rule.rb +236 -0
  245. data/lib/mux_ruby/models/overall_values.rb +51 -17
  246. data/lib/mux_ruby/models/playback_id.rb +50 -15
  247. data/lib/mux_ruby/models/playback_policy.rb +12 -6
  248. data/lib/mux_ruby/models/real_time_breakdown_value.rb +254 -0
  249. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +227 -0
  250. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +227 -0
  251. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +274 -0
  252. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +236 -0
  253. data/lib/mux_ruby/models/score.rb +53 -19
  254. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
  255. data/lib/mux_ruby/models/signing_key.rb +53 -16
  256. data/lib/mux_ruby/models/signing_key_response.rb +48 -14
  257. data/lib/mux_ruby/models/simulcast_target.rb +55 -21
  258. data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
  259. data/lib/mux_ruby/models/track.rb +92 -33
  260. data/lib/mux_ruby/models/update_asset_master_access_request.rb +51 -17
  261. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +51 -17
  262. data/lib/mux_ruby/models/upload.rb +62 -26
  263. data/lib/mux_ruby/models/upload_error.rb +51 -15
  264. data/lib/mux_ruby/models/upload_response.rb +48 -14
  265. data/lib/mux_ruby/models/video_view.rb +242 -136
  266. data/lib/mux_ruby/models/video_view_event.rb +51 -17
  267. data/lib/mux_ruby/models/video_view_response.rb +49 -15
  268. data/lib/mux_ruby/version.rb +10 -3
  269. data/mux_ruby.gemspec +15 -15
  270. data/spec/api/assets_api_spec.rb +2 -0
  271. data/spec/api/dimensions_api_spec.rb +55 -0
  272. data/spec/api/filters_api_spec.rb +2 -2
  273. data/spec/api/incidents_api_spec.rb +73 -0
  274. data/spec/api/live_streams_api_spec.rb +24 -0
  275. data/spec/api/playback_id_api_spec.rb +40 -0
  276. data/spec/api/real_time_api_spec.rb +93 -0
  277. data/spec/api_client_spec.rb +10 -3
  278. data/spec/configuration_spec.rb +9 -2
  279. data/spec/models/asset_master_spec.rb +4 -0
  280. data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
  281. data/spec/models/asset_recording_times_spec.rb +40 -0
  282. data/spec/models/asset_spec.rb +26 -0
  283. data/spec/models/dimension_value_spec.rb +40 -0
  284. data/spec/models/disable_live_stream_response_spec.rb +34 -0
  285. data/spec/models/enable_live_stream_response_spec.rb +34 -0
  286. data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
  287. data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
  288. data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
  289. data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
  290. data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
  291. data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
  292. data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
  293. data/spec/models/incident_breakdown_spec.rb +46 -0
  294. data/spec/models/incident_notification_rule_spec.rb +58 -0
  295. data/spec/models/incident_notification_spec.rb +46 -0
  296. data/spec/models/incident_response_spec.rb +40 -0
  297. data/spec/models/incident_spec.rb +154 -0
  298. data/spec/models/input_settings_spec.rb +12 -0
  299. data/spec/models/list_dimension_values_response_spec.rb +46 -0
  300. data/spec/models/list_dimensions_response_spec.rb +46 -0
  301. data/spec/models/list_incidents_response_spec.rb +46 -0
  302. data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
  303. data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
  304. data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
  305. data/spec/models/list_related_incidents_response_spec.rb +46 -0
  306. data/spec/models/notification_rule_spec.rb +46 -0
  307. data/spec/models/real_time_breakdown_value_spec.rb +58 -0
  308. data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
  309. data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
  310. data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
  311. data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
  312. data/spec/models/track_spec.rb +4 -0
  313. data/spec/spec_helper.rb +9 -2
  314. metadata +246 -209
@@ -1,9 +1,16 @@
1
1
  =begin
2
- # Mux Ruby - Copyright 2019 Mux Inc.
3
- # NOTE: This file is auto generated. Do not edit this file manually.
2
+ #Mux API
3
+
4
+ #Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: devex@mux.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.1
10
+
4
11
  =end
5
12
 
6
- require 'uri'
13
+ require 'cgi'
7
14
 
8
15
  module MuxRuby
9
16
  class ErrorsApi
@@ -13,10 +20,10 @@ module MuxRuby
13
20
  @api_client = api_client
14
21
  end
15
22
  # List Errors
16
- # Returns a list of errors
23
+ # Returns a list of errors.
17
24
  # @param [Hash] opts the optional parameters
18
- # @option opts [Array<String>] :filters 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.
19
- # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
25
+ # @option opts [Array<String>] :filters 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.
26
+ # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
20
27
  # @return [ListErrorsResponse]
21
28
  def list_errors(opts = {})
22
29
  data, _status_code, _headers = list_errors_with_http_info(opts)
@@ -24,11 +31,11 @@ module MuxRuby
24
31
  end
25
32
 
26
33
  # List Errors
27
- # Returns a list of errors
34
+ # Returns a list of errors.
28
35
  # @param [Hash] opts the optional parameters
29
- # @option opts [Array<String>] :filters 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.
30
- # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
31
- # @return [Array<(ListErrorsResponse, Fixnum, Hash)>] ListErrorsResponse data, response status code and response headers
36
+ # @option opts [Array<String>] :filters 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.
37
+ # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
38
+ # @return [Array<(ListErrorsResponse, Integer, Hash)>] ListErrorsResponse data, response status code and response headers
32
39
  def list_errors_with_http_info(opts = {})
33
40
  if @api_client.config.debugging
34
41
  @api_client.config.logger.debug 'Calling API: ErrorsApi.list_errors ...'
@@ -37,33 +44,42 @@ module MuxRuby
37
44
  local_var_path = '/data/v1/errors'
38
45
 
39
46
  # query parameters
40
- query_params = {}
47
+ query_params = opts[:query_params] || {}
41
48
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
42
49
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
43
50
 
44
51
  # header parameters
45
- header_params = {}
52
+ header_params = opts[:header_params] || {}
46
53
  # HTTP header 'Accept' (if needed)
47
54
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
48
55
 
49
56
  # form parameters
50
- form_params = {}
57
+ form_params = opts[:form_params] || {}
51
58
 
52
59
  # http body (model)
53
- post_body = nil
54
- auth_names = ['accessToken']
55
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'ListErrorsResponse'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['accessToken']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"ErrorsApi.list_errors",
56
70
  :header_params => header_params,
57
71
  :query_params => query_params,
58
72
  :form_params => form_params,
59
73
  :body => post_body,
60
74
  :auth_names => auth_names,
61
- :return_type => 'ListErrorsResponse')
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
62
79
  if @api_client.config.debugging
63
80
  @api_client.config.logger.debug "API called: ErrorsApi#list_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
64
81
  end
65
82
  return data, status_code, headers
66
83
  end
67
-
68
84
  end
69
85
  end
@@ -1,9 +1,16 @@
1
1
  =begin
2
- # Mux Ruby - Copyright 2019 Mux Inc.
3
- # NOTE: This file is auto generated. Do not edit this file manually.
2
+ #Mux API
3
+
4
+ #Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: devex@mux.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.1
10
+
4
11
  =end
5
12
 
6
- require 'uri'
13
+ require 'cgi'
7
14
 
8
15
  module MuxRuby
9
16
  class ExportsApi
@@ -13,7 +20,7 @@ module MuxRuby
13
20
  @api_client = api_client
14
21
  end
15
22
  # List property video view export links
16
- # Lists the available video view exports along with URLs to retrieve them
23
+ # Lists the available video view exports along with URLs to retrieve them.
17
24
  # @param [Hash] opts the optional parameters
18
25
  # @return [ListExportsResponse]
19
26
  def list_exports(opts = {})
@@ -22,9 +29,9 @@ module MuxRuby
22
29
  end
23
30
 
24
31
  # List property video view export links
25
- # Lists the available video view exports along with URLs to retrieve them
32
+ # Lists the available video view exports along with URLs to retrieve them.
26
33
  # @param [Hash] opts the optional parameters
27
- # @return [Array<(ListExportsResponse, Fixnum, Hash)>] ListExportsResponse data, response status code and response headers
34
+ # @return [Array<(ListExportsResponse, Integer, Hash)>] ListExportsResponse data, response status code and response headers
28
35
  def list_exports_with_http_info(opts = {})
29
36
  if @api_client.config.debugging
30
37
  @api_client.config.logger.debug 'Calling API: ExportsApi.list_exports ...'
@@ -33,31 +40,40 @@ module MuxRuby
33
40
  local_var_path = '/data/v1/exports'
34
41
 
35
42
  # query parameters
36
- query_params = {}
43
+ query_params = opts[:query_params] || {}
37
44
 
38
45
  # header parameters
39
- header_params = {}
46
+ header_params = opts[:header_params] || {}
40
47
  # HTTP header 'Accept' (if needed)
41
48
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
42
49
 
43
50
  # form parameters
44
- form_params = {}
51
+ form_params = opts[:form_params] || {}
45
52
 
46
53
  # http body (model)
47
- post_body = nil
48
- auth_names = ['accessToken']
49
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
54
+ post_body = opts[:debug_body]
55
+
56
+ # return_type
57
+ return_type = opts[:debug_return_type] || 'ListExportsResponse'
58
+
59
+ # auth_names
60
+ auth_names = opts[:debug_auth_names] || ['accessToken']
61
+
62
+ new_options = opts.merge(
63
+ :operation => :"ExportsApi.list_exports",
50
64
  :header_params => header_params,
51
65
  :query_params => query_params,
52
66
  :form_params => form_params,
53
67
  :body => post_body,
54
68
  :auth_names => auth_names,
55
- :return_type => 'ListExportsResponse')
69
+ :return_type => return_type
70
+ )
71
+
72
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
56
73
  if @api_client.config.debugging
57
74
  @api_client.config.logger.debug "API called: ExportsApi#list_exports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
58
75
  end
59
76
  return data, status_code, headers
60
77
  end
61
-
62
78
  end
63
79
  end
@@ -1,9 +1,16 @@
1
1
  =begin
2
- # Mux Ruby - Copyright 2019 Mux Inc.
3
- # NOTE: This file is auto generated. Do not edit this file manually.
2
+ #Mux API
3
+
4
+ #Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: devex@mux.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.1
10
+
4
11
  =end
5
12
 
6
- require 'uri'
13
+ require 'cgi'
7
14
 
8
15
  module MuxRuby
9
16
  class FiltersApi
@@ -13,13 +20,13 @@ module MuxRuby
13
20
  @api_client = api_client
14
21
  end
15
22
  # Lists values for a specific filter
16
- # Lists the values for a filter along with a total count of related views
17
- # @param filter_id ID of the Filter
23
+ # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
24
+ # @param filter_id [String] ID of the Filter
18
25
  # @param [Hash] opts the optional parameters
19
26
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
20
27
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
21
- # @option opts [Array<String>] :filters 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.
22
- # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
28
+ # @option opts [Array<String>] :filters 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.
29
+ # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
23
30
  # @return [ListFilterValuesResponse]
24
31
  def list_filter_values(filter_id, opts = {})
25
32
  data, _status_code, _headers = list_filter_values_with_http_info(filter_id, opts)
@@ -27,14 +34,14 @@ module MuxRuby
27
34
  end
28
35
 
29
36
  # Lists values for a specific filter
30
- # Lists the values for a filter along with a total count of related views
31
- # @param filter_id ID of the Filter
37
+ # Deprecated: The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.
38
+ # @param filter_id [String] ID of the Filter
32
39
  # @param [Hash] opts the optional parameters
33
40
  # @option opts [Integer] :limit Number of items to include in the response
34
41
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
35
- # @option opts [Array<String>] :filters 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.
36
- # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
37
- # @return [Array<(ListFilterValuesResponse, Fixnum, Hash)>] ListFilterValuesResponse data, response status code and response headers
42
+ # @option opts [Array<String>] :filters 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.
43
+ # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.
44
+ # @return [Array<(ListFilterValuesResponse, Integer, Hash)>] ListFilterValuesResponse data, response status code and response headers
38
45
  def list_filter_values_with_http_info(filter_id, opts = {})
39
46
  if @api_client.config.debugging
40
47
  @api_client.config.logger.debug 'Calling API: FiltersApi.list_filter_values ...'
@@ -44,33 +51,43 @@ module MuxRuby
44
51
  fail ArgumentError, "Missing the required parameter 'filter_id' when calling FiltersApi.list_filter_values"
45
52
  end
46
53
  # resource path
47
- local_var_path = '/data/v1/filters/{FILTER_ID}'.sub('{' + 'FILTER_ID' + '}', filter_id.to_s)
54
+ local_var_path = '/data/v1/filters/{FILTER_ID}'.sub('{' + 'FILTER_ID' + '}', CGI.escape(filter_id.to_s))
48
55
 
49
56
  # query parameters
50
- query_params = {}
57
+ query_params = opts[:query_params] || {}
51
58
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
52
59
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
53
60
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
54
61
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
55
62
 
56
63
  # header parameters
57
- header_params = {}
64
+ header_params = opts[:header_params] || {}
58
65
  # HTTP header 'Accept' (if needed)
59
66
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
60
67
 
61
68
  # form parameters
62
- form_params = {}
69
+ form_params = opts[:form_params] || {}
63
70
 
64
71
  # http body (model)
65
- post_body = nil
66
- auth_names = ['accessToken']
67
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'ListFilterValuesResponse'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['accessToken']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"FiltersApi.list_filter_values",
68
82
  :header_params => header_params,
69
83
  :query_params => query_params,
70
84
  :form_params => form_params,
71
85
  :body => post_body,
72
86
  :auth_names => auth_names,
73
- :return_type => 'ListFilterValuesResponse')
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
74
91
  if @api_client.config.debugging
75
92
  @api_client.config.logger.debug "API called: FiltersApi#list_filter_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
76
93
  end
@@ -78,7 +95,7 @@ module MuxRuby
78
95
  end
79
96
 
80
97
  # List Filters
81
- # Lists all the filters broken out into basic and advanced
98
+ # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
82
99
  # @param [Hash] opts the optional parameters
83
100
  # @return [ListFiltersResponse]
84
101
  def list_filters(opts = {})
@@ -87,9 +104,9 @@ module MuxRuby
87
104
  end
88
105
 
89
106
  # List Filters
90
- # Lists all the filters broken out into basic and advanced
107
+ # Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.
91
108
  # @param [Hash] opts the optional parameters
92
- # @return [Array<(ListFiltersResponse, Fixnum, Hash)>] ListFiltersResponse data, response status code and response headers
109
+ # @return [Array<(ListFiltersResponse, Integer, Hash)>] ListFiltersResponse data, response status code and response headers
93
110
  def list_filters_with_http_info(opts = {})
94
111
  if @api_client.config.debugging
95
112
  @api_client.config.logger.debug 'Calling API: FiltersApi.list_filters ...'
@@ -98,31 +115,40 @@ module MuxRuby
98
115
  local_var_path = '/data/v1/filters'
99
116
 
100
117
  # query parameters
101
- query_params = {}
118
+ query_params = opts[:query_params] || {}
102
119
 
103
120
  # header parameters
104
- header_params = {}
121
+ header_params = opts[:header_params] || {}
105
122
  # HTTP header 'Accept' (if needed)
106
123
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
107
124
 
108
125
  # form parameters
109
- form_params = {}
126
+ form_params = opts[:form_params] || {}
110
127
 
111
128
  # http body (model)
112
- post_body = nil
113
- auth_names = ['accessToken']
114
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
129
+ post_body = opts[:debug_body]
130
+
131
+ # return_type
132
+ return_type = opts[:debug_return_type] || 'ListFiltersResponse'
133
+
134
+ # auth_names
135
+ auth_names = opts[:debug_auth_names] || ['accessToken']
136
+
137
+ new_options = opts.merge(
138
+ :operation => :"FiltersApi.list_filters",
115
139
  :header_params => header_params,
116
140
  :query_params => query_params,
117
141
  :form_params => form_params,
118
142
  :body => post_body,
119
143
  :auth_names => auth_names,
120
- :return_type => 'ListFiltersResponse')
144
+ :return_type => return_type
145
+ )
146
+
147
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
121
148
  if @api_client.config.debugging
122
149
  @api_client.config.logger.debug "API called: FiltersApi#list_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
123
150
  end
124
151
  return data, status_code, headers
125
152
  end
126
-
127
153
  end
128
154
  end
@@ -0,0 +1,259 @@
1
+ =begin
2
+ #Mux API
3
+
4
+ #Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: devex@mux.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MuxRuby
16
+ class IncidentsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get an Incident
23
+ # Returns the details of an incident.
24
+ # @param incident_id [String] ID of the Incident
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [IncidentResponse]
27
+ def get_incident(incident_id, opts = {})
28
+ data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
29
+ data
30
+ end
31
+
32
+ # Get an Incident
33
+ # Returns the details of an incident.
34
+ # @param incident_id [String] ID of the Incident
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(IncidentResponse, Integer, Hash)>] IncidentResponse data, response status code and response headers
37
+ def get_incident_with_http_info(incident_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.get_incident ...'
40
+ end
41
+ # verify the required parameter 'incident_id' is set
42
+ if @api_client.config.client_side_validation && incident_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.get_incident"
44
+ end
45
+ # resource path
46
+ local_var_path = '/data/v1/incidents/{INCIDENT_ID}'.sub('{' + 'INCIDENT_ID' + '}', CGI.escape(incident_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'IncidentResponse'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['accessToken']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"IncidentsApi.get_incident",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: IncidentsApi#get_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
85
+ # List Incidents
86
+ # Returns a list of incidents.
87
+ # @param [Hash] opts the optional parameters
88
+ # @option opts [Integer] :limit Number of items to include in the response (default to 25)
89
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
90
+ # @option opts [String] :order_by Value to order the results by
91
+ # @option opts [String] :order_direction Sort order.
92
+ # @option opts [String] :status Status to filter incidents by
93
+ # @option opts [String] :severity Severity to filter incidents by
94
+ # @return [ListIncidentsResponse]
95
+ def list_incidents(opts = {})
96
+ data, _status_code, _headers = list_incidents_with_http_info(opts)
97
+ data
98
+ end
99
+
100
+ # List Incidents
101
+ # Returns a list of incidents.
102
+ # @param [Hash] opts the optional parameters
103
+ # @option opts [Integer] :limit Number of items to include in the response
104
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
105
+ # @option opts [String] :order_by Value to order the results by
106
+ # @option opts [String] :order_direction Sort order.
107
+ # @option opts [String] :status Status to filter incidents by
108
+ # @option opts [String] :severity Severity to filter incidents by
109
+ # @return [Array<(ListIncidentsResponse, Integer, Hash)>] ListIncidentsResponse data, response status code and response headers
110
+ def list_incidents_with_http_info(opts = {})
111
+ if @api_client.config.debugging
112
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.list_incidents ...'
113
+ end
114
+ allowable_values = ["negative_impact", "value", "views", "field"]
115
+ if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
116
+ fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
117
+ end
118
+ allowable_values = ["asc", "desc"]
119
+ if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
120
+ fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
121
+ end
122
+ allowable_values = ["open", "closed", "expired"]
123
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
124
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
125
+ end
126
+ allowable_values = ["warning", "alert"]
127
+ if @api_client.config.client_side_validation && opts[:'severity'] && !allowable_values.include?(opts[:'severity'])
128
+ fail ArgumentError, "invalid value for \"severity\", must be one of #{allowable_values}"
129
+ end
130
+ # resource path
131
+ local_var_path = '/data/v1/incidents'
132
+
133
+ # query parameters
134
+ query_params = opts[:query_params] || {}
135
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
136
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
137
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
138
+ query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
139
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
140
+ query_params[:'severity'] = opts[:'severity'] if !opts[:'severity'].nil?
141
+
142
+ # header parameters
143
+ header_params = opts[:header_params] || {}
144
+ # HTTP header 'Accept' (if needed)
145
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
146
+
147
+ # form parameters
148
+ form_params = opts[:form_params] || {}
149
+
150
+ # http body (model)
151
+ post_body = opts[:debug_body]
152
+
153
+ # return_type
154
+ return_type = opts[:debug_return_type] || 'ListIncidentsResponse'
155
+
156
+ # auth_names
157
+ auth_names = opts[:debug_auth_names] || ['accessToken']
158
+
159
+ new_options = opts.merge(
160
+ :operation => :"IncidentsApi.list_incidents",
161
+ :header_params => header_params,
162
+ :query_params => query_params,
163
+ :form_params => form_params,
164
+ :body => post_body,
165
+ :auth_names => auth_names,
166
+ :return_type => return_type
167
+ )
168
+
169
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug "API called: IncidentsApi#list_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
172
+ end
173
+ return data, status_code, headers
174
+ end
175
+
176
+ # List Related Incidents
177
+ # Returns all the incidents that seem related to a specific incident.
178
+ # @param incident_id [String] ID of the Incident
179
+ # @param [Hash] opts the optional parameters
180
+ # @option opts [Integer] :limit Number of items to include in the response (default to 25)
181
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
182
+ # @option opts [String] :order_by Value to order the results by
183
+ # @option opts [String] :order_direction Sort order.
184
+ # @return [ListRelatedIncidentsResponse]
185
+ def list_related_incidents(incident_id, opts = {})
186
+ data, _status_code, _headers = list_related_incidents_with_http_info(incident_id, opts)
187
+ data
188
+ end
189
+
190
+ # List Related Incidents
191
+ # Returns all the incidents that seem related to a specific incident.
192
+ # @param incident_id [String] ID of the Incident
193
+ # @param [Hash] opts the optional parameters
194
+ # @option opts [Integer] :limit Number of items to include in the response
195
+ # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
196
+ # @option opts [String] :order_by Value to order the results by
197
+ # @option opts [String] :order_direction Sort order.
198
+ # @return [Array<(ListRelatedIncidentsResponse, Integer, Hash)>] ListRelatedIncidentsResponse data, response status code and response headers
199
+ def list_related_incidents_with_http_info(incident_id, opts = {})
200
+ if @api_client.config.debugging
201
+ @api_client.config.logger.debug 'Calling API: IncidentsApi.list_related_incidents ...'
202
+ end
203
+ # verify the required parameter 'incident_id' is set
204
+ if @api_client.config.client_side_validation && incident_id.nil?
205
+ fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.list_related_incidents"
206
+ end
207
+ allowable_values = ["negative_impact", "value", "views", "field"]
208
+ if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
209
+ fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
210
+ end
211
+ allowable_values = ["asc", "desc"]
212
+ if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
213
+ fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
214
+ end
215
+ # resource path
216
+ local_var_path = '/data/v1/incidents/{INCIDENT_ID}/related'.sub('{' + 'INCIDENT_ID' + '}', CGI.escape(incident_id.to_s))
217
+
218
+ # query parameters
219
+ query_params = opts[:query_params] || {}
220
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
221
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
222
+ query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
223
+ query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
224
+
225
+ # header parameters
226
+ header_params = opts[:header_params] || {}
227
+ # HTTP header 'Accept' (if needed)
228
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
229
+
230
+ # form parameters
231
+ form_params = opts[:form_params] || {}
232
+
233
+ # http body (model)
234
+ post_body = opts[:debug_body]
235
+
236
+ # return_type
237
+ return_type = opts[:debug_return_type] || 'ListRelatedIncidentsResponse'
238
+
239
+ # auth_names
240
+ auth_names = opts[:debug_auth_names] || ['accessToken']
241
+
242
+ new_options = opts.merge(
243
+ :operation => :"IncidentsApi.list_related_incidents",
244
+ :header_params => header_params,
245
+ :query_params => query_params,
246
+ :form_params => form_params,
247
+ :body => post_body,
248
+ :auth_names => auth_names,
249
+ :return_type => return_type
250
+ )
251
+
252
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug "API called: IncidentsApi#list_related_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
255
+ end
256
+ return data, status_code, headers
257
+ end
258
+ end
259
+ end