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,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
+
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 LiveStreamsApi
@@ -13,7 +20,7 @@ module MuxRuby
13
20
  @api_client = api_client
14
21
  end
15
22
  # Create a live stream
16
- # @param create_live_stream_request
23
+ # @param create_live_stream_request [CreateLiveStreamRequest]
17
24
  # @param [Hash] opts the optional parameters
18
25
  # @return [LiveStreamResponse]
19
26
  def create_live_stream(create_live_stream_request, opts = {})
@@ -22,9 +29,9 @@ module MuxRuby
22
29
  end
23
30
 
24
31
  # Create a live stream
25
- # @param create_live_stream_request
32
+ # @param create_live_stream_request [CreateLiveStreamRequest]
26
33
  # @param [Hash] opts the optional parameters
27
- # @return [Array<(LiveStreamResponse, Fixnum, Hash)>] LiveStreamResponse data, response status code and response headers
34
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
28
35
  def create_live_stream_with_http_info(create_live_stream_request, opts = {})
29
36
  if @api_client.config.debugging
30
37
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.create_live_stream ...'
@@ -37,28 +44,38 @@ module MuxRuby
37
44
  local_var_path = '/video/v1/live-streams'
38
45
 
39
46
  # query parameters
40
- query_params = {}
47
+ query_params = opts[:query_params] || {}
41
48
 
42
49
  # header parameters
43
- header_params = {}
50
+ header_params = opts[:header_params] || {}
44
51
  # HTTP header 'Accept' (if needed)
45
52
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
46
53
  # HTTP header 'Content-Type'
47
54
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 = @api_client.object_to_http_body(create_live_stream_request)
54
- auth_names = ['accessToken']
55
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
60
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_live_stream_request)
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['accessToken']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"LiveStreamsApi.create_live_stream",
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 => 'LiveStreamResponse')
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
62
79
  if @api_client.config.debugging
63
80
  @api_client.config.logger.debug "API called: LiveStreamsApi#create_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
64
81
  end
@@ -66,8 +83,8 @@ module MuxRuby
66
83
  end
67
84
 
68
85
  # Create a live stream playback ID
69
- # @param live_stream_id The live stream ID
70
- # @param create_playback_id_request
86
+ # @param live_stream_id [String] The live stream ID
87
+ # @param create_playback_id_request [CreatePlaybackIDRequest]
71
88
  # @param [Hash] opts the optional parameters
72
89
  # @return [CreatePlaybackIDResponse]
73
90
  def create_live_stream_playback_id(live_stream_id, create_playback_id_request, opts = {})
@@ -76,10 +93,10 @@ module MuxRuby
76
93
  end
77
94
 
78
95
  # Create a live stream playback ID
79
- # @param live_stream_id The live stream ID
80
- # @param create_playback_id_request
96
+ # @param live_stream_id [String] The live stream ID
97
+ # @param create_playback_id_request [CreatePlaybackIDRequest]
81
98
  # @param [Hash] opts the optional parameters
82
- # @return [Array<(CreatePlaybackIDResponse, Fixnum, Hash)>] CreatePlaybackIDResponse data, response status code and response headers
99
+ # @return [Array<(CreatePlaybackIDResponse, Integer, Hash)>] CreatePlaybackIDResponse data, response status code and response headers
83
100
  def create_live_stream_playback_id_with_http_info(live_stream_id, create_playback_id_request, opts = {})
84
101
  if @api_client.config.debugging
85
102
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.create_live_stream_playback_id ...'
@@ -93,31 +110,41 @@ module MuxRuby
93
110
  fail ArgumentError, "Missing the required parameter 'create_playback_id_request' when calling LiveStreamsApi.create_live_stream_playback_id"
94
111
  end
95
112
  # resource path
96
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
113
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
97
114
 
98
115
  # query parameters
99
- query_params = {}
116
+ query_params = opts[:query_params] || {}
100
117
 
101
118
  # header parameters
102
- header_params = {}
119
+ header_params = opts[:header_params] || {}
103
120
  # HTTP header 'Accept' (if needed)
104
121
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
105
122
  # HTTP header 'Content-Type'
106
123
  header_params['Content-Type'] = @api_client.select_header_content_type(['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 = @api_client.object_to_http_body(create_playback_id_request)
113
- auth_names = ['accessToken']
114
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
129
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_playback_id_request)
130
+
131
+ # return_type
132
+ return_type = opts[:debug_return_type] || 'CreatePlaybackIDResponse'
133
+
134
+ # auth_names
135
+ auth_names = opts[:debug_auth_names] || ['accessToken']
136
+
137
+ new_options = opts.merge(
138
+ :operation => :"LiveStreamsApi.create_live_stream_playback_id",
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 => 'CreatePlaybackIDResponse')
144
+ :return_type => return_type
145
+ )
146
+
147
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
121
148
  if @api_client.config.debugging
122
149
  @api_client.config.logger.debug "API called: LiveStreamsApi#create_live_stream_playback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
123
150
  end
@@ -126,8 +153,8 @@ module MuxRuby
126
153
 
127
154
  # Create a live stream simulcast target
128
155
  # Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
129
- # @param live_stream_id The live stream ID
130
- # @param create_simulcast_target_request
156
+ # @param live_stream_id [String] The live stream ID
157
+ # @param create_simulcast_target_request [CreateSimulcastTargetRequest]
131
158
  # @param [Hash] opts the optional parameters
132
159
  # @return [SimulcastTargetResponse]
133
160
  def create_live_stream_simulcast_target(live_stream_id, create_simulcast_target_request, opts = {})
@@ -137,10 +164,10 @@ module MuxRuby
137
164
 
138
165
  # Create a live stream simulcast target
139
166
  # Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.
140
- # @param live_stream_id The live stream ID
141
- # @param create_simulcast_target_request
167
+ # @param live_stream_id [String] The live stream ID
168
+ # @param create_simulcast_target_request [CreateSimulcastTargetRequest]
142
169
  # @param [Hash] opts the optional parameters
143
- # @return [Array<(SimulcastTargetResponse, Fixnum, Hash)>] SimulcastTargetResponse data, response status code and response headers
170
+ # @return [Array<(SimulcastTargetResponse, Integer, Hash)>] SimulcastTargetResponse data, response status code and response headers
144
171
  def create_live_stream_simulcast_target_with_http_info(live_stream_id, create_simulcast_target_request, opts = {})
145
172
  if @api_client.config.debugging
146
173
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.create_live_stream_simulcast_target ...'
@@ -154,31 +181,41 @@ module MuxRuby
154
181
  fail ArgumentError, "Missing the required parameter 'create_simulcast_target_request' when calling LiveStreamsApi.create_live_stream_simulcast_target"
155
182
  end
156
183
  # resource path
157
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
184
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
158
185
 
159
186
  # query parameters
160
- query_params = {}
187
+ query_params = opts[:query_params] || {}
161
188
 
162
189
  # header parameters
163
- header_params = {}
190
+ header_params = opts[:header_params] || {}
164
191
  # HTTP header 'Accept' (if needed)
165
192
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
166
193
  # HTTP header 'Content-Type'
167
194
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
168
195
 
169
196
  # form parameters
170
- form_params = {}
197
+ form_params = opts[:form_params] || {}
171
198
 
172
199
  # http body (model)
173
- post_body = @api_client.object_to_http_body(create_simulcast_target_request)
174
- auth_names = ['accessToken']
175
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
200
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_simulcast_target_request)
201
+
202
+ # return_type
203
+ return_type = opts[:debug_return_type] || 'SimulcastTargetResponse'
204
+
205
+ # auth_names
206
+ auth_names = opts[:debug_auth_names] || ['accessToken']
207
+
208
+ new_options = opts.merge(
209
+ :operation => :"LiveStreamsApi.create_live_stream_simulcast_target",
176
210
  :header_params => header_params,
177
211
  :query_params => query_params,
178
212
  :form_params => form_params,
179
213
  :body => post_body,
180
214
  :auth_names => auth_names,
181
- :return_type => 'SimulcastTargetResponse')
215
+ :return_type => return_type
216
+ )
217
+
218
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
182
219
  if @api_client.config.debugging
183
220
  @api_client.config.logger.debug "API called: LiveStreamsApi#create_live_stream_simulcast_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
221
  end
@@ -186,7 +223,7 @@ module MuxRuby
186
223
  end
187
224
 
188
225
  # Delete a live stream
189
- # @param live_stream_id The live stream ID
226
+ # @param live_stream_id [String] The live stream ID
190
227
  # @param [Hash] opts the optional parameters
191
228
  # @return [nil]
192
229
  def delete_live_stream(live_stream_id, opts = {})
@@ -195,9 +232,9 @@ module MuxRuby
195
232
  end
196
233
 
197
234
  # Delete a live stream
198
- # @param live_stream_id The live stream ID
235
+ # @param live_stream_id [String] The live stream ID
199
236
  # @param [Hash] opts the optional parameters
200
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
237
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
201
238
  def delete_live_stream_with_http_info(live_stream_id, opts = {})
202
239
  if @api_client.config.debugging
203
240
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.delete_live_stream ...'
@@ -207,26 +244,37 @@ module MuxRuby
207
244
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.delete_live_stream"
208
245
  end
209
246
  # resource path
210
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
247
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
211
248
 
212
249
  # query parameters
213
- query_params = {}
250
+ query_params = opts[:query_params] || {}
214
251
 
215
252
  # header parameters
216
- header_params = {}
253
+ header_params = opts[:header_params] || {}
217
254
 
218
255
  # form parameters
219
- form_params = {}
256
+ form_params = opts[:form_params] || {}
220
257
 
221
258
  # http body (model)
222
- post_body = nil
223
- auth_names = ['accessToken']
224
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
259
+ post_body = opts[:debug_body]
260
+
261
+ # return_type
262
+ return_type = opts[:debug_return_type]
263
+
264
+ # auth_names
265
+ auth_names = opts[:debug_auth_names] || ['accessToken']
266
+
267
+ new_options = opts.merge(
268
+ :operation => :"LiveStreamsApi.delete_live_stream",
225
269
  :header_params => header_params,
226
270
  :query_params => query_params,
227
271
  :form_params => form_params,
228
272
  :body => post_body,
229
- :auth_names => auth_names)
273
+ :auth_names => auth_names,
274
+ :return_type => return_type
275
+ )
276
+
277
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
230
278
  if @api_client.config.debugging
231
279
  @api_client.config.logger.debug "API called: LiveStreamsApi#delete_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
232
280
  end
@@ -234,8 +282,8 @@ module MuxRuby
234
282
  end
235
283
 
236
284
  # Delete a live stream playback ID
237
- # @param live_stream_id The live stream ID
238
- # @param playback_id The live stream&#39;s playback ID.
285
+ # @param live_stream_id [String] The live stream ID
286
+ # @param playback_id [String] The live stream&#39;s playback ID.
239
287
  # @param [Hash] opts the optional parameters
240
288
  # @return [nil]
241
289
  def delete_live_stream_playback_id(live_stream_id, playback_id, opts = {})
@@ -244,10 +292,10 @@ module MuxRuby
244
292
  end
245
293
 
246
294
  # Delete a live stream playback ID
247
- # @param live_stream_id The live stream ID
248
- # @param playback_id The live stream&#39;s playback ID.
295
+ # @param live_stream_id [String] The live stream ID
296
+ # @param playback_id [String] The live stream&#39;s playback ID.
249
297
  # @param [Hash] opts the optional parameters
250
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
298
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
251
299
  def delete_live_stream_playback_id_with_http_info(live_stream_id, playback_id, opts = {})
252
300
  if @api_client.config.debugging
253
301
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.delete_live_stream_playback_id ...'
@@ -261,26 +309,37 @@ module MuxRuby
261
309
  fail ArgumentError, "Missing the required parameter 'playback_id' when calling LiveStreamsApi.delete_live_stream_playback_id"
262
310
  end
263
311
  # resource path
264
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s).sub('{' + 'PLAYBACK_ID' + '}', playback_id.to_s)
312
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s)).sub('{' + 'PLAYBACK_ID' + '}', CGI.escape(playback_id.to_s))
265
313
 
266
314
  # query parameters
267
- query_params = {}
315
+ query_params = opts[:query_params] || {}
268
316
 
269
317
  # header parameters
270
- header_params = {}
318
+ header_params = opts[:header_params] || {}
271
319
 
272
320
  # form parameters
273
- form_params = {}
321
+ form_params = opts[:form_params] || {}
274
322
 
275
323
  # http body (model)
276
- post_body = nil
277
- auth_names = ['accessToken']
278
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
324
+ post_body = opts[:debug_body]
325
+
326
+ # return_type
327
+ return_type = opts[:debug_return_type]
328
+
329
+ # auth_names
330
+ auth_names = opts[:debug_auth_names] || ['accessToken']
331
+
332
+ new_options = opts.merge(
333
+ :operation => :"LiveStreamsApi.delete_live_stream_playback_id",
279
334
  :header_params => header_params,
280
335
  :query_params => query_params,
281
336
  :form_params => form_params,
282
337
  :body => post_body,
283
- :auth_names => auth_names)
338
+ :auth_names => auth_names,
339
+ :return_type => return_type
340
+ )
341
+
342
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
284
343
  if @api_client.config.debugging
285
344
  @api_client.config.logger.debug "API called: LiveStreamsApi#delete_live_stream_playback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
286
345
  end
@@ -289,8 +348,8 @@ module MuxRuby
289
348
 
290
349
  # Delete a Live Stream Simulcast Target
291
350
  # Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
292
- # @param live_stream_id The live stream ID
293
- # @param simulcast_target_id The ID of the simulcast target.
351
+ # @param live_stream_id [String] The live stream ID
352
+ # @param simulcast_target_id [String] The ID of the simulcast target.
294
353
  # @param [Hash] opts the optional parameters
295
354
  # @return [nil]
296
355
  def delete_live_stream_simulcast_target(live_stream_id, simulcast_target_id, opts = {})
@@ -300,10 +359,10 @@ module MuxRuby
300
359
 
301
360
  # Delete a Live Stream Simulcast Target
302
361
  # Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.
303
- # @param live_stream_id The live stream ID
304
- # @param simulcast_target_id The ID of the simulcast target.
362
+ # @param live_stream_id [String] The live stream ID
363
+ # @param simulcast_target_id [String] The ID of the simulcast target.
305
364
  # @param [Hash] opts the optional parameters
306
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
365
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
307
366
  def delete_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id, opts = {})
308
367
  if @api_client.config.debugging
309
368
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.delete_live_stream_simulcast_target ...'
@@ -317,26 +376,37 @@ module MuxRuby
317
376
  fail ArgumentError, "Missing the required parameter 'simulcast_target_id' when calling LiveStreamsApi.delete_live_stream_simulcast_target"
318
377
  end
319
378
  # resource path
320
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s).sub('{' + 'SIMULCAST_TARGET_ID' + '}', simulcast_target_id.to_s)
379
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s)).sub('{' + 'SIMULCAST_TARGET_ID' + '}', CGI.escape(simulcast_target_id.to_s))
321
380
 
322
381
  # query parameters
323
- query_params = {}
382
+ query_params = opts[:query_params] || {}
324
383
 
325
384
  # header parameters
326
- header_params = {}
385
+ header_params = opts[:header_params] || {}
327
386
 
328
387
  # form parameters
329
- form_params = {}
388
+ form_params = opts[:form_params] || {}
330
389
 
331
390
  # http body (model)
332
- post_body = nil
333
- auth_names = ['accessToken']
334
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
391
+ post_body = opts[:debug_body]
392
+
393
+ # return_type
394
+ return_type = opts[:debug_return_type]
395
+
396
+ # auth_names
397
+ auth_names = opts[:debug_auth_names] || ['accessToken']
398
+
399
+ new_options = opts.merge(
400
+ :operation => :"LiveStreamsApi.delete_live_stream_simulcast_target",
335
401
  :header_params => header_params,
336
402
  :query_params => query_params,
337
403
  :form_params => form_params,
338
404
  :body => post_body,
339
- :auth_names => auth_names)
405
+ :auth_names => auth_names,
406
+ :return_type => return_type
407
+ )
408
+
409
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
340
410
  if @api_client.config.debugging
341
411
  @api_client.config.logger.debug "API called: LiveStreamsApi#delete_live_stream_simulcast_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
342
412
  end
@@ -344,8 +414,8 @@ module MuxRuby
344
414
  end
345
415
 
346
416
  # Disable a live stream
347
- # Disables a live stream, making it reject incoming RTMP streams until re-enabled.
348
- # @param live_stream_id The live stream ID
417
+ # Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the `EXT-X-ENDLIST` tag to the HLS manifest which notifies the player that this live stream is over. Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.
418
+ # @param live_stream_id [String] The live stream ID
349
419
  # @param [Hash] opts the optional parameters
350
420
  # @return [DisableLiveStreamResponse]
351
421
  def disable_live_stream(live_stream_id, opts = {})
@@ -354,10 +424,10 @@ module MuxRuby
354
424
  end
355
425
 
356
426
  # Disable a live stream
357
- # Disables a live stream, making it reject incoming RTMP streams until re-enabled.
358
- # @param live_stream_id The live stream ID
427
+ # Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the &#x60;EXT-X-ENDLIST&#x60; tag to the HLS manifest which notifies the player that this live stream is over. Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.
428
+ # @param live_stream_id [String] The live stream ID
359
429
  # @param [Hash] opts the optional parameters
360
- # @return [Array<(DisableLiveStreamResponse, Fixnum, Hash)>] DisableLiveStreamResponse data, response status code and response headers
430
+ # @return [Array<(DisableLiveStreamResponse, Integer, Hash)>] DisableLiveStreamResponse data, response status code and response headers
361
431
  def disable_live_stream_with_http_info(live_stream_id, opts = {})
362
432
  if @api_client.config.debugging
363
433
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.disable_live_stream ...'
@@ -367,29 +437,39 @@ module MuxRuby
367
437
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.disable_live_stream"
368
438
  end
369
439
  # resource path
370
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/disable'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
440
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/disable'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
371
441
 
372
442
  # query parameters
373
- query_params = {}
443
+ query_params = opts[:query_params] || {}
374
444
 
375
445
  # header parameters
376
- header_params = {}
446
+ header_params = opts[:header_params] || {}
377
447
  # HTTP header 'Accept' (if needed)
378
448
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
379
449
 
380
450
  # form parameters
381
- form_params = {}
451
+ form_params = opts[:form_params] || {}
382
452
 
383
453
  # http body (model)
384
- post_body = nil
385
- auth_names = ['accessToken']
386
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
454
+ post_body = opts[:debug_body]
455
+
456
+ # return_type
457
+ return_type = opts[:debug_return_type] || 'DisableLiveStreamResponse'
458
+
459
+ # auth_names
460
+ auth_names = opts[:debug_auth_names] || ['accessToken']
461
+
462
+ new_options = opts.merge(
463
+ :operation => :"LiveStreamsApi.disable_live_stream",
387
464
  :header_params => header_params,
388
465
  :query_params => query_params,
389
466
  :form_params => form_params,
390
467
  :body => post_body,
391
468
  :auth_names => auth_names,
392
- :return_type => 'DisableLiveStreamResponse')
469
+ :return_type => return_type
470
+ )
471
+
472
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
393
473
  if @api_client.config.debugging
394
474
  @api_client.config.logger.debug "API called: LiveStreamsApi#disable_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
395
475
  end
@@ -398,7 +478,7 @@ module MuxRuby
398
478
 
399
479
  # Enable a live stream
400
480
  # Enables a live stream, allowing it to accept an incoming RTMP stream.
401
- # @param live_stream_id The live stream ID
481
+ # @param live_stream_id [String] The live stream ID
402
482
  # @param [Hash] opts the optional parameters
403
483
  # @return [EnableLiveStreamResponse]
404
484
  def enable_live_stream(live_stream_id, opts = {})
@@ -408,9 +488,9 @@ module MuxRuby
408
488
 
409
489
  # Enable a live stream
410
490
  # Enables a live stream, allowing it to accept an incoming RTMP stream.
411
- # @param live_stream_id The live stream ID
491
+ # @param live_stream_id [String] The live stream ID
412
492
  # @param [Hash] opts the optional parameters
413
- # @return [Array<(EnableLiveStreamResponse, Fixnum, Hash)>] EnableLiveStreamResponse data, response status code and response headers
493
+ # @return [Array<(EnableLiveStreamResponse, Integer, Hash)>] EnableLiveStreamResponse data, response status code and response headers
414
494
  def enable_live_stream_with_http_info(live_stream_id, opts = {})
415
495
  if @api_client.config.debugging
416
496
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.enable_live_stream ...'
@@ -420,29 +500,39 @@ module MuxRuby
420
500
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.enable_live_stream"
421
501
  end
422
502
  # resource path
423
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/enable'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
503
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/enable'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
424
504
 
425
505
  # query parameters
426
- query_params = {}
506
+ query_params = opts[:query_params] || {}
427
507
 
428
508
  # header parameters
429
- header_params = {}
509
+ header_params = opts[:header_params] || {}
430
510
  # HTTP header 'Accept' (if needed)
431
511
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
432
512
 
433
513
  # form parameters
434
- form_params = {}
514
+ form_params = opts[:form_params] || {}
435
515
 
436
516
  # http body (model)
437
- post_body = nil
438
- auth_names = ['accessToken']
439
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
517
+ post_body = opts[:debug_body]
518
+
519
+ # return_type
520
+ return_type = opts[:debug_return_type] || 'EnableLiveStreamResponse'
521
+
522
+ # auth_names
523
+ auth_names = opts[:debug_auth_names] || ['accessToken']
524
+
525
+ new_options = opts.merge(
526
+ :operation => :"LiveStreamsApi.enable_live_stream",
440
527
  :header_params => header_params,
441
528
  :query_params => query_params,
442
529
  :form_params => form_params,
443
530
  :body => post_body,
444
531
  :auth_names => auth_names,
445
- :return_type => 'EnableLiveStreamResponse')
532
+ :return_type => return_type
533
+ )
534
+
535
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
446
536
  if @api_client.config.debugging
447
537
  @api_client.config.logger.debug "API called: LiveStreamsApi#enable_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
538
  end
@@ -451,7 +541,7 @@ module MuxRuby
451
541
 
452
542
  # Retrieve a live stream
453
543
  # Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
454
- # @param live_stream_id The live stream ID
544
+ # @param live_stream_id [String] The live stream ID
455
545
  # @param [Hash] opts the optional parameters
456
546
  # @return [LiveStreamResponse]
457
547
  def get_live_stream(live_stream_id, opts = {})
@@ -461,9 +551,9 @@ module MuxRuby
461
551
 
462
552
  # Retrieve a live stream
463
553
  # Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.
464
- # @param live_stream_id The live stream ID
554
+ # @param live_stream_id [String] The live stream ID
465
555
  # @param [Hash] opts the optional parameters
466
- # @return [Array<(LiveStreamResponse, Fixnum, Hash)>] LiveStreamResponse data, response status code and response headers
556
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
467
557
  def get_live_stream_with_http_info(live_stream_id, opts = {})
468
558
  if @api_client.config.debugging
469
559
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.get_live_stream ...'
@@ -473,29 +563,39 @@ module MuxRuby
473
563
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.get_live_stream"
474
564
  end
475
565
  # resource path
476
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
566
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
477
567
 
478
568
  # query parameters
479
- query_params = {}
569
+ query_params = opts[:query_params] || {}
480
570
 
481
571
  # header parameters
482
- header_params = {}
572
+ header_params = opts[:header_params] || {}
483
573
  # HTTP header 'Accept' (if needed)
484
574
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
485
575
 
486
576
  # form parameters
487
- form_params = {}
577
+ form_params = opts[:form_params] || {}
488
578
 
489
579
  # http body (model)
490
- post_body = nil
491
- auth_names = ['accessToken']
492
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
580
+ post_body = opts[:debug_body]
581
+
582
+ # return_type
583
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
584
+
585
+ # auth_names
586
+ auth_names = opts[:debug_auth_names] || ['accessToken']
587
+
588
+ new_options = opts.merge(
589
+ :operation => :"LiveStreamsApi.get_live_stream",
493
590
  :header_params => header_params,
494
591
  :query_params => query_params,
495
592
  :form_params => form_params,
496
593
  :body => post_body,
497
594
  :auth_names => auth_names,
498
- :return_type => 'LiveStreamResponse')
595
+ :return_type => return_type
596
+ )
597
+
598
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
499
599
  if @api_client.config.debugging
500
600
  @api_client.config.logger.debug "API called: LiveStreamsApi#get_live_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
501
601
  end
@@ -504,8 +604,8 @@ module MuxRuby
504
604
 
505
605
  # Retrieve a Live Stream Simulcast Target
506
606
  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
507
- # @param live_stream_id The live stream ID
508
- # @param simulcast_target_id The ID of the simulcast target.
607
+ # @param live_stream_id [String] The live stream ID
608
+ # @param simulcast_target_id [String] The ID of the simulcast target.
509
609
  # @param [Hash] opts the optional parameters
510
610
  # @return [SimulcastTargetResponse]
511
611
  def get_live_stream_simulcast_target(live_stream_id, simulcast_target_id, opts = {})
@@ -515,10 +615,10 @@ module MuxRuby
515
615
 
516
616
  # Retrieve a Live Stream Simulcast Target
517
617
  # Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.
518
- # @param live_stream_id The live stream ID
519
- # @param simulcast_target_id The ID of the simulcast target.
618
+ # @param live_stream_id [String] The live stream ID
619
+ # @param simulcast_target_id [String] The ID of the simulcast target.
520
620
  # @param [Hash] opts the optional parameters
521
- # @return [Array<(SimulcastTargetResponse, Fixnum, Hash)>] SimulcastTargetResponse data, response status code and response headers
621
+ # @return [Array<(SimulcastTargetResponse, Integer, Hash)>] SimulcastTargetResponse data, response status code and response headers
522
622
  def get_live_stream_simulcast_target_with_http_info(live_stream_id, simulcast_target_id, opts = {})
523
623
  if @api_client.config.debugging
524
624
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.get_live_stream_simulcast_target ...'
@@ -532,29 +632,39 @@ module MuxRuby
532
632
  fail ArgumentError, "Missing the required parameter 'simulcast_target_id' when calling LiveStreamsApi.get_live_stream_simulcast_target"
533
633
  end
534
634
  # resource path
535
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s).sub('{' + 'SIMULCAST_TARGET_ID' + '}', simulcast_target_id.to_s)
635
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s)).sub('{' + 'SIMULCAST_TARGET_ID' + '}', CGI.escape(simulcast_target_id.to_s))
536
636
 
537
637
  # query parameters
538
- query_params = {}
638
+ query_params = opts[:query_params] || {}
539
639
 
540
640
  # header parameters
541
- header_params = {}
641
+ header_params = opts[:header_params] || {}
542
642
  # HTTP header 'Accept' (if needed)
543
643
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
544
644
 
545
645
  # form parameters
546
- form_params = {}
646
+ form_params = opts[:form_params] || {}
547
647
 
548
648
  # http body (model)
549
- post_body = nil
550
- auth_names = ['accessToken']
551
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
649
+ post_body = opts[:debug_body]
650
+
651
+ # return_type
652
+ return_type = opts[:debug_return_type] || 'SimulcastTargetResponse'
653
+
654
+ # auth_names
655
+ auth_names = opts[:debug_auth_names] || ['accessToken']
656
+
657
+ new_options = opts.merge(
658
+ :operation => :"LiveStreamsApi.get_live_stream_simulcast_target",
552
659
  :header_params => header_params,
553
660
  :query_params => query_params,
554
661
  :form_params => form_params,
555
662
  :body => post_body,
556
663
  :auth_names => auth_names,
557
- :return_type => 'SimulcastTargetResponse')
664
+ :return_type => return_type
665
+ )
666
+
667
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
558
668
  if @api_client.config.debugging
559
669
  @api_client.config.logger.debug "API called: LiveStreamsApi#get_live_stream_simulcast_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
560
670
  end
@@ -565,6 +675,7 @@ module MuxRuby
565
675
  # @param [Hash] opts the optional parameters
566
676
  # @option opts [Integer] :limit Number of items to include in the response (default to 25)
567
677
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
678
+ # @option opts [String] :stream_key Filter response to return live stream for this stream key only
568
679
  # @return [ListLiveStreamsResponse]
569
680
  def list_live_streams(opts = {})
570
681
  data, _status_code, _headers = list_live_streams_with_http_info(opts)
@@ -575,7 +686,8 @@ module MuxRuby
575
686
  # @param [Hash] opts the optional parameters
576
687
  # @option opts [Integer] :limit Number of items to include in the response
577
688
  # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
578
- # @return [Array<(ListLiveStreamsResponse, Fixnum, Hash)>] ListLiveStreamsResponse data, response status code and response headers
689
+ # @option opts [String] :stream_key Filter response to return live stream for this stream key only
690
+ # @return [Array<(ListLiveStreamsResponse, Integer, Hash)>] ListLiveStreamsResponse data, response status code and response headers
579
691
  def list_live_streams_with_http_info(opts = {})
580
692
  if @api_client.config.debugging
581
693
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.list_live_streams ...'
@@ -584,28 +696,39 @@ module MuxRuby
584
696
  local_var_path = '/video/v1/live-streams'
585
697
 
586
698
  # query parameters
587
- query_params = {}
699
+ query_params = opts[:query_params] || {}
588
700
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
589
701
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
702
+ query_params[:'stream_key'] = opts[:'stream_key'] if !opts[:'stream_key'].nil?
590
703
 
591
704
  # header parameters
592
- header_params = {}
705
+ header_params = opts[:header_params] || {}
593
706
  # HTTP header 'Accept' (if needed)
594
707
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
595
708
 
596
709
  # form parameters
597
- form_params = {}
710
+ form_params = opts[:form_params] || {}
598
711
 
599
712
  # http body (model)
600
- post_body = nil
601
- auth_names = ['accessToken']
602
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
713
+ post_body = opts[:debug_body]
714
+
715
+ # return_type
716
+ return_type = opts[:debug_return_type] || 'ListLiveStreamsResponse'
717
+
718
+ # auth_names
719
+ auth_names = opts[:debug_auth_names] || ['accessToken']
720
+
721
+ new_options = opts.merge(
722
+ :operation => :"LiveStreamsApi.list_live_streams",
603
723
  :header_params => header_params,
604
724
  :query_params => query_params,
605
725
  :form_params => form_params,
606
726
  :body => post_body,
607
727
  :auth_names => auth_names,
608
- :return_type => 'ListLiveStreamsResponse')
728
+ :return_type => return_type
729
+ )
730
+
731
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
609
732
  if @api_client.config.debugging
610
733
  @api_client.config.logger.debug "API called: LiveStreamsApi#list_live_streams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
611
734
  end
@@ -614,7 +737,7 @@ module MuxRuby
614
737
 
615
738
  # Reset a live stream’s stream key
616
739
  # Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
617
- # @param live_stream_id The live stream ID
740
+ # @param live_stream_id [String] The live stream ID
618
741
  # @param [Hash] opts the optional parameters
619
742
  # @return [LiveStreamResponse]
620
743
  def reset_stream_key(live_stream_id, opts = {})
@@ -624,9 +747,9 @@ module MuxRuby
624
747
 
625
748
  # Reset a live stream’s stream key
626
749
  # Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.
627
- # @param live_stream_id The live stream ID
750
+ # @param live_stream_id [String] The live stream ID
628
751
  # @param [Hash] opts the optional parameters
629
- # @return [Array<(LiveStreamResponse, Fixnum, Hash)>] LiveStreamResponse data, response status code and response headers
752
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
630
753
  def reset_stream_key_with_http_info(live_stream_id, opts = {})
631
754
  if @api_client.config.debugging
632
755
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.reset_stream_key ...'
@@ -636,29 +759,39 @@ module MuxRuby
636
759
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.reset_stream_key"
637
760
  end
638
761
  # resource path
639
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
762
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
640
763
 
641
764
  # query parameters
642
- query_params = {}
765
+ query_params = opts[:query_params] || {}
643
766
 
644
767
  # header parameters
645
- header_params = {}
768
+ header_params = opts[:header_params] || {}
646
769
  # HTTP header 'Accept' (if needed)
647
770
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
648
771
 
649
772
  # form parameters
650
- form_params = {}
773
+ form_params = opts[:form_params] || {}
651
774
 
652
775
  # http body (model)
653
- post_body = nil
654
- auth_names = ['accessToken']
655
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
776
+ post_body = opts[:debug_body]
777
+
778
+ # return_type
779
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
780
+
781
+ # auth_names
782
+ auth_names = opts[:debug_auth_names] || ['accessToken']
783
+
784
+ new_options = opts.merge(
785
+ :operation => :"LiveStreamsApi.reset_stream_key",
656
786
  :header_params => header_params,
657
787
  :query_params => query_params,
658
788
  :form_params => form_params,
659
789
  :body => post_body,
660
790
  :auth_names => auth_names,
661
- :return_type => 'LiveStreamResponse')
791
+ :return_type => return_type
792
+ )
793
+
794
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
662
795
  if @api_client.config.debugging
663
796
  @api_client.config.logger.debug "API called: LiveStreamsApi#reset_stream_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
664
797
  end
@@ -666,8 +799,8 @@ module MuxRuby
666
799
  end
667
800
 
668
801
  # Signal a live stream is finished
669
- # (Optional) Make the recorded asset available immediately instead of waiting for the reconnect_window.
670
- # @param live_stream_id The live stream ID
802
+ # (Optional) End the live stream recording immediately instead of waiting for the reconnect_window. `EXT-X-ENDLIST` tag is added to the HLS manifest which notifies the player that this live stream is over. Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.
803
+ # @param live_stream_id [String] The live stream ID
671
804
  # @param [Hash] opts the optional parameters
672
805
  # @return [SignalLiveStreamCompleteResponse]
673
806
  def signal_live_stream_complete(live_stream_id, opts = {})
@@ -676,10 +809,10 @@ module MuxRuby
676
809
  end
677
810
 
678
811
  # Signal a live stream is finished
679
- # (Optional) Make the recorded asset available immediately instead of waiting for the reconnect_window.
680
- # @param live_stream_id The live stream ID
812
+ # (Optional) End the live stream recording immediately instead of waiting for the reconnect_window. &#x60;EXT-X-ENDLIST&#x60; tag is added to the HLS manifest which notifies the player that this live stream is over. Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.
813
+ # @param live_stream_id [String] The live stream ID
681
814
  # @param [Hash] opts the optional parameters
682
- # @return [Array<(SignalLiveStreamCompleteResponse, Fixnum, Hash)>] SignalLiveStreamCompleteResponse data, response status code and response headers
815
+ # @return [Array<(SignalLiveStreamCompleteResponse, Integer, Hash)>] SignalLiveStreamCompleteResponse data, response status code and response headers
683
816
  def signal_live_stream_complete_with_http_info(live_stream_id, opts = {})
684
817
  if @api_client.config.debugging
685
818
  @api_client.config.logger.debug 'Calling API: LiveStreamsApi.signal_live_stream_complete ...'
@@ -689,34 +822,43 @@ module MuxRuby
689
822
  fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.signal_live_stream_complete"
690
823
  end
691
824
  # resource path
692
- local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/complete'.sub('{' + 'LIVE_STREAM_ID' + '}', live_stream_id.to_s)
825
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/complete'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
693
826
 
694
827
  # query parameters
695
- query_params = {}
828
+ query_params = opts[:query_params] || {}
696
829
 
697
830
  # header parameters
698
- header_params = {}
831
+ header_params = opts[:header_params] || {}
699
832
  # HTTP header 'Accept' (if needed)
700
833
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
701
834
 
702
835
  # form parameters
703
- form_params = {}
836
+ form_params = opts[:form_params] || {}
704
837
 
705
838
  # http body (model)
706
- post_body = nil
707
- auth_names = ['accessToken']
708
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
839
+ post_body = opts[:debug_body]
840
+
841
+ # return_type
842
+ return_type = opts[:debug_return_type] || 'SignalLiveStreamCompleteResponse'
843
+
844
+ # auth_names
845
+ auth_names = opts[:debug_auth_names] || ['accessToken']
846
+
847
+ new_options = opts.merge(
848
+ :operation => :"LiveStreamsApi.signal_live_stream_complete",
709
849
  :header_params => header_params,
710
850
  :query_params => query_params,
711
851
  :form_params => form_params,
712
852
  :body => post_body,
713
853
  :auth_names => auth_names,
714
- :return_type => 'SignalLiveStreamCompleteResponse')
854
+ :return_type => return_type
855
+ )
856
+
857
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
715
858
  if @api_client.config.debugging
716
859
  @api_client.config.logger.debug "API called: LiveStreamsApi#signal_live_stream_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
717
860
  end
718
861
  return data, status_code, headers
719
862
  end
720
-
721
863
  end
722
864
  end