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,12 +1,26 @@
1
1
  # MuxRuby::RealTimeBreakdownValue
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **String** | | [optional]
7
- **negative_impact** | **Integer** | | [optional]
8
- **metric_value** | **Float** | | [optional]
9
- **display_value** | **String** | | [optional]
10
- **concurent_viewers** | **Integer** | | [optional]
11
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | | [optional] |
8
+ | **negative_impact** | **Integer** | | [optional] |
9
+ | **metric_value** | **Float** | | [optional] |
10
+ | **display_value** | **String** | | [optional] |
11
+ | **concurent_viewers** | **Integer** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mux_ruby'
17
+
18
+ instance = MuxRuby::RealTimeBreakdownValue.new(
19
+ value: null,
20
+ negative_impact: null,
21
+ metric_value: null,
22
+ display_value: null,
23
+ concurent_viewers: null
24
+ )
25
+ ```
12
26
 
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::RealTimeHistogramTimeseriesBucket
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **start** | **Integer** | | [optional]
7
- **_end** | **Integer** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **start** | **Integer** | | [optional] |
8
+ | **_end** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::RealTimeHistogramTimeseriesBucket.new(
16
+ start: null,
17
+ _end: null
18
+ )
19
+ ```
9
20
 
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::RealTimeHistogramTimeseriesBucketValues
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **percentage** | **Float** | | [optional]
7
- **count** | **Integer** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **percentage** | **Float** | | [optional] |
8
+ | **count** | **Integer** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::RealTimeHistogramTimeseriesBucketValues.new(
16
+ percentage: null,
17
+ count: null
18
+ )
19
+ ```
9
20
 
@@ -1,14 +1,30 @@
1
1
  # MuxRuby::RealTimeHistogramTimeseriesDatapoint
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **timestamp** | **String** | | [optional]
7
- **sum** | **Integer** | | [optional]
8
- **p95** | **Float** | | [optional]
9
- **median** | **Float** | | [optional]
10
- **max_percentage** | **Float** | | [optional]
11
- **bucket_values** | [**Array<RealTimeHistogramTimeseriesBucketValues>**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional]
12
- **average** | **Float** | | [optional]
13
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **timestamp** | **String** | | [optional] |
8
+ | **sum** | **Integer** | | [optional] |
9
+ | **p95** | **Float** | | [optional] |
10
+ | **median** | **Float** | | [optional] |
11
+ | **max_percentage** | **Float** | | [optional] |
12
+ | **bucket_values** | [**Array<RealTimeHistogramTimeseriesBucketValues>**](RealTimeHistogramTimeseriesBucketValues.md) | | [optional] |
13
+ | **average** | **Float** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mux_ruby'
19
+
20
+ instance = MuxRuby::RealTimeHistogramTimeseriesDatapoint.new(
21
+ timestamp: null,
22
+ sum: null,
23
+ p95: null,
24
+ median: null,
25
+ max_percentage: null,
26
+ bucket_values: null,
27
+ average: null
28
+ )
29
+ ```
14
30
 
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::RealTimeTimeseriesDatapoint
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **value** | **Float** | | [optional]
7
- **date** | **String** | | [optional]
8
- **concurent_viewers** | **Integer** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **Float** | | [optional] |
8
+ | **date** | **String** | | [optional] |
9
+ | **concurent_viewers** | **Integer** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::RealTimeTimeseriesDatapoint.new(
17
+ value: null,
18
+ date: null,
19
+ concurent_viewers: null
20
+ )
21
+ ```
10
22
 
data/docs/Score.md CHANGED
@@ -1,13 +1,28 @@
1
1
  # MuxRuby::Score
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **watch_time** | **Integer** | | [optional]
7
- **view_count** | **Integer** | | [optional]
8
- **name** | **String** | | [optional]
9
- **value** | **Float** | | [optional]
10
- **metric** | **String** | | [optional]
11
- **items** | [**Array<Metric>**](Metric.md) | | [optional]
12
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **watch_time** | **Integer** | | [optional] |
8
+ | **view_count** | **Integer** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **value** | **Float** | | [optional] |
11
+ | **metric** | **String** | | [optional] |
12
+ | **items** | [**Array<Metric>**](Metric.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'mux_ruby'
18
+
19
+ instance = MuxRuby::Score.new(
20
+ watch_time: null,
21
+ view_count: null,
22
+ name: null,
23
+ value: null,
24
+ metric: null,
25
+ items: null
26
+ )
27
+ ```
13
28
 
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::SignalLiveStreamCompleteResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Object**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::SignalLiveStreamCompleteResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
data/docs/SigningKey.md CHANGED
@@ -1,10 +1,22 @@
1
1
  # MuxRuby::SigningKey
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | | [optional]
7
- **created_at** | **String** | | [optional]
8
- **private_key** | **String** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Signing Key. | [optional] |
8
+ | **created_at** | **String** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional] |
9
+ | **private_key** | **String** | A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.** | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::SigningKey.new(
17
+ id: null,
18
+ created_at: null,
19
+ private_key: null
20
+ )
21
+ ```
10
22
 
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::SigningKeyResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**SigningKey**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**SigningKey**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::SigningKeyResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
@@ -1,12 +1,26 @@
1
1
  # MuxRuby::SimulcastTarget
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | ID of the Simulcast Target | [optional]
7
- **passthrough** | **String** | Arbitrary Metadata set when creating a simulcast target. | [optional]
8
- **status** | **String** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional]
9
- **stream_key** | **String** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional]
10
- **url** | **String** | RTMP hostname including the application name for the third party live streaming service. | [optional]
11
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | ID of the Simulcast Target | [optional] |
8
+ | **passthrough** | **String** | Arbitrary Metadata set when creating a simulcast target. | [optional] |
9
+ | **status** | **String** | The current status of the simulcast target. See Statuses below for detailed description. * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state. * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state. * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service. * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established. | [optional] |
10
+ | **stream_key** | **String** | Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too. | [optional] |
11
+ | **url** | **String** | RTMP hostname including the application name for the third party live streaming service. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mux_ruby'
17
+
18
+ instance = MuxRuby::SimulcastTarget.new(
19
+ id: null,
20
+ passthrough: null,
21
+ status: null,
22
+ stream_key: null,
23
+ url: null
24
+ )
25
+ ```
12
26
 
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::SimulcastTargetResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**SimulcastTarget**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**SimulcastTarget**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::SimulcastTargetResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
data/docs/Track.md CHANGED
@@ -1,20 +1,42 @@
1
1
  # MuxRuby::Track
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | Unique identifier for the Track | [optional]
7
- **type** | **String** | The type of track | [optional]
8
- **duration** | **Float** | The duration in seconds of the track media. This parameter is not set for the `text` type track. This field is optional and may not be set. The top level `duration` field of an asset will always be set. | [optional]
9
- **max_width** | **Integer** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional]
10
- **max_height** | **Integer** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional]
11
- **max_frame_rate** | **Float** | The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. | [optional]
12
- **max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional]
13
- **max_channel_layout** | **String** | Only set for the `audio` type track. | [optional]
14
- **text_type** | **String** | This parameter is set only for the `text` type track. | [optional]
15
- **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is set for `text` type and `subtitles` text type track. | [optional]
16
- **name** | **String** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is set for the `text` type and `subtitles` text type track. | [optional]
17
- **closed_captions** | **BOOLEAN** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the `text` type and `subtitles` text type track. | [optional]
18
- **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. This parameter is set for `text` type and `subtitles` text type track. Max 255 characters. | [optional]
19
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Track | [optional] |
8
+ | **type** | **String** | The type of track | [optional] |
9
+ | **duration** | **Float** | The duration in seconds of the track media. This parameter is not set for the `text` type track. This field is optional and may not be set. The top level `duration` field of an asset will always be set. | [optional] |
10
+ | **max_width** | **Integer** | The maximum width in pixels available for the track. Only set for the `video` type track. | [optional] |
11
+ | **max_height** | **Integer** | The maximum height in pixels available for the track. Only set for the `video` type track. | [optional] |
12
+ | **max_frame_rate** | **Float** | The maximum frame rate available for the track. Only set for the `video` type track. This field may return `-1` if the frame rate of the input cannot be reliably determined. | [optional] |
13
+ | **max_channels** | **Integer** | The maximum number of audio channels the track supports. Only set for the `audio` type track. | [optional] |
14
+ | **max_channel_layout** | **String** | Only set for the `audio` type track. | [optional] |
15
+ | **text_type** | **String** | This parameter is set only for the `text` type track. | [optional] |
16
+ | **language_code** | **String** | The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is set for `text` type and `subtitles` text type track. | [optional] |
17
+ | **name** | **String** | The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is \"English\" for subtitles text track for the `language_code` value of `en-US`. This parameter is set for the `text` type and `subtitles` text type track. | [optional] |
18
+ | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the `text` type and `subtitles` text type track. | [optional] |
19
+ | **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. This parameter is set for `text` type and `subtitles` text type track. Max 255 characters. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'mux_ruby'
25
+
26
+ instance = MuxRuby::Track.new(
27
+ id: null,
28
+ type: null,
29
+ duration: null,
30
+ max_width: null,
31
+ max_height: null,
32
+ max_frame_rate: null,
33
+ max_channels: null,
34
+ max_channel_layout: null,
35
+ text_type: null,
36
+ language_code: null,
37
+ name: null,
38
+ closed_captions: null,
39
+ passthrough: null
40
+ )
41
+ ```
20
42
 
@@ -2,24 +2,26 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_url_signing_key**](URLSigningKeysApi.md#create_url_signing_key) | **POST** /video/v1/signing-keys | Create a URL signing key
8
- [**delete_url_signing_key**](URLSigningKeysApi.md#delete_url_signing_key) | **DELETE** /video/v1/signing-keys/{SIGNING_KEY_ID} | Delete a URL signing key
9
- [**get_url_signing_key**](URLSigningKeysApi.md#get_url_signing_key) | **GET** /video/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a URL signing key
10
- [**list_url_signing_keys**](URLSigningKeysApi.md#list_url_signing_keys) | **GET** /video/v1/signing-keys | List URL signing keys
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_url_signing_key**](URLSigningKeysApi.md#create_url_signing_key) | **POST** /video/v1/signing-keys | Create a URL signing key |
8
+ | [**delete_url_signing_key**](URLSigningKeysApi.md#delete_url_signing_key) | **DELETE** /video/v1/signing-keys/{SIGNING_KEY_ID} | Delete a URL signing key |
9
+ | [**get_url_signing_key**](URLSigningKeysApi.md#get_url_signing_key) | **GET** /video/v1/signing-keys/{SIGNING_KEY_ID} | Retrieve a URL signing key |
10
+ | [**list_url_signing_keys**](URLSigningKeysApi.md#list_url_signing_keys) | **GET** /video/v1/signing-keys | List URL signing keys |
11
11
 
12
12
 
13
- # **create_url_signing_key**
14
- > SigningKeyResponse create_url_signing_key
13
+ ## create_url_signing_key
14
+
15
+ > <SigningKeyResponse> create_url_signing_key
15
16
 
16
17
  Create a URL signing key
17
18
 
18
19
  Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.
19
20
 
20
- ### Example
21
+ ### Examples
22
+
21
23
  ```ruby
22
- # load the gem
24
+ require 'time'
23
25
  require 'mux_ruby'
24
26
  # setup authorization
25
27
  MuxRuby.configure do |config|
@@ -31,15 +33,34 @@ end
31
33
  api_instance = MuxRuby::URLSigningKeysApi.new
32
34
 
33
35
  begin
34
- #Create a URL signing key
36
+ # Create a URL signing key
35
37
  result = api_instance.create_url_signing_key
36
38
  p result
37
39
  rescue MuxRuby::ApiError => e
38
- puts "Exception when calling URLSigningKeysApi->create_url_signing_key: #{e}"
40
+ puts "Error when calling URLSigningKeysApi->create_url_signing_key: #{e}"
41
+ end
42
+ ```
43
+
44
+ #### Using the create_url_signing_key_with_http_info variant
45
+
46
+ This returns an Array which contains the response data, status code and headers.
47
+
48
+ > <Array(<SigningKeyResponse>, Integer, Hash)> create_url_signing_key_with_http_info
49
+
50
+ ```ruby
51
+ begin
52
+ # Create a URL signing key
53
+ data, status_code, headers = api_instance.create_url_signing_key_with_http_info
54
+ p status_code # => 2xx
55
+ p headers # => { ... }
56
+ p data # => <SigningKeyResponse>
57
+ rescue MuxRuby::ApiError => e
58
+ puts "Error when calling URLSigningKeysApi->create_url_signing_key_with_http_info: #{e}"
39
59
  end
40
60
  ```
41
61
 
42
62
  ### Parameters
63
+
43
64
  This endpoint does not need any parameter.
44
65
 
45
66
  ### Return type
@@ -52,21 +73,22 @@ This endpoint does not need any parameter.
52
73
 
53
74
  ### HTTP request headers
54
75
 
55
- - **Content-Type**: Not defined
56
- - **Accept**: application/json
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
57
78
 
58
79
 
80
+ ## delete_url_signing_key
59
81
 
60
- # **delete_url_signing_key**
61
82
  > delete_url_signing_key(signing_key_id)
62
83
 
63
84
  Delete a URL signing key
64
85
 
65
86
  Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.
66
87
 
67
- ### Example
88
+ ### Examples
89
+
68
90
  ```ruby
69
- # load the gem
91
+ require 'time'
70
92
  require 'mux_ruby'
71
93
  # setup authorization
72
94
  MuxRuby.configure do |config|
@@ -79,18 +101,36 @@ api_instance = MuxRuby::URLSigningKeysApi.new
79
101
  signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
80
102
 
81
103
  begin
82
- #Delete a URL signing key
104
+ # Delete a URL signing key
83
105
  api_instance.delete_url_signing_key(signing_key_id)
84
106
  rescue MuxRuby::ApiError => e
85
- puts "Exception when calling URLSigningKeysApi->delete_url_signing_key: #{e}"
107
+ puts "Error when calling URLSigningKeysApi->delete_url_signing_key: #{e}"
108
+ end
109
+ ```
110
+
111
+ #### Using the delete_url_signing_key_with_http_info variant
112
+
113
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
114
+
115
+ > <Array(nil, Integer, Hash)> delete_url_signing_key_with_http_info(signing_key_id)
116
+
117
+ ```ruby
118
+ begin
119
+ # Delete a URL signing key
120
+ data, status_code, headers = api_instance.delete_url_signing_key_with_http_info(signing_key_id)
121
+ p status_code # => 2xx
122
+ p headers # => { ... }
123
+ p data # => nil
124
+ rescue MuxRuby::ApiError => e
125
+ puts "Error when calling URLSigningKeysApi->delete_url_signing_key_with_http_info: #{e}"
86
126
  end
87
127
  ```
88
128
 
89
129
  ### Parameters
90
130
 
91
- Name | Type | Description | Notes
92
- ------------- | ------------- | ------------- | -------------
93
- **signing_key_id** | **String**| The ID of the signing key. |
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | **signing_key_id** | **String** | The ID of the signing key. | |
94
134
 
95
135
  ### Return type
96
136
 
@@ -102,21 +142,22 @@ nil (empty response body)
102
142
 
103
143
  ### HTTP request headers
104
144
 
105
- - **Content-Type**: Not defined
106
- - **Accept**: Not defined
145
+ - **Content-Type**: Not defined
146
+ - **Accept**: Not defined
107
147
 
108
148
 
149
+ ## get_url_signing_key
109
150
 
110
- # **get_url_signing_key**
111
- > SigningKeyResponse get_url_signing_key(signing_key_id)
151
+ > <SigningKeyResponse> get_url_signing_key(signing_key_id)
112
152
 
113
153
  Retrieve a URL signing key
114
154
 
115
155
  Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**
116
156
 
117
- ### Example
157
+ ### Examples
158
+
118
159
  ```ruby
119
- # load the gem
160
+ require 'time'
120
161
  require 'mux_ruby'
121
162
  # setup authorization
122
163
  MuxRuby.configure do |config|
@@ -129,19 +170,37 @@ api_instance = MuxRuby::URLSigningKeysApi.new
129
170
  signing_key_id = 'signing_key_id_example' # String | The ID of the signing key.
130
171
 
131
172
  begin
132
- #Retrieve a URL signing key
173
+ # Retrieve a URL signing key
133
174
  result = api_instance.get_url_signing_key(signing_key_id)
134
175
  p result
135
176
  rescue MuxRuby::ApiError => e
136
- puts "Exception when calling URLSigningKeysApi->get_url_signing_key: #{e}"
177
+ puts "Error when calling URLSigningKeysApi->get_url_signing_key: #{e}"
178
+ end
179
+ ```
180
+
181
+ #### Using the get_url_signing_key_with_http_info variant
182
+
183
+ This returns an Array which contains the response data, status code and headers.
184
+
185
+ > <Array(<SigningKeyResponse>, Integer, Hash)> get_url_signing_key_with_http_info(signing_key_id)
186
+
187
+ ```ruby
188
+ begin
189
+ # Retrieve a URL signing key
190
+ data, status_code, headers = api_instance.get_url_signing_key_with_http_info(signing_key_id)
191
+ p status_code # => 2xx
192
+ p headers # => { ... }
193
+ p data # => <SigningKeyResponse>
194
+ rescue MuxRuby::ApiError => e
195
+ puts "Error when calling URLSigningKeysApi->get_url_signing_key_with_http_info: #{e}"
137
196
  end
138
197
  ```
139
198
 
140
199
  ### Parameters
141
200
 
142
- Name | Type | Description | Notes
143
- ------------- | ------------- | ------------- | -------------
144
- **signing_key_id** | **String**| The ID of the signing key. |
201
+ | Name | Type | Description | Notes |
202
+ | ---- | ---- | ----------- | ----- |
203
+ | **signing_key_id** | **String** | The ID of the signing key. | |
145
204
 
146
205
  ### Return type
147
206
 
@@ -153,21 +212,22 @@ Name | Type | Description | Notes
153
212
 
154
213
  ### HTTP request headers
155
214
 
156
- - **Content-Type**: Not defined
157
- - **Accept**: application/json
215
+ - **Content-Type**: Not defined
216
+ - **Accept**: application/json
158
217
 
159
218
 
219
+ ## list_url_signing_keys
160
220
 
161
- # **list_url_signing_keys**
162
- > ListSigningKeysResponse list_url_signing_keys(opts)
221
+ > <ListSigningKeysResponse> list_url_signing_keys(opts)
163
222
 
164
223
  List URL signing keys
165
224
 
166
225
  Returns a list of URL signing keys.
167
226
 
168
- ### Example
227
+ ### Examples
228
+
169
229
  ```ruby
170
- # load the gem
230
+ require 'time'
171
231
  require 'mux_ruby'
172
232
  # setup authorization
173
233
  MuxRuby.configure do |config|
@@ -178,25 +238,43 @@ end
178
238
 
179
239
  api_instance = MuxRuby::URLSigningKeysApi.new
180
240
  opts = {
181
- limit: 25, # Integer | Number of items to include in the response
182
- page: 1 # Integer | Offset by this many pages, of the size of `limit`
241
+ limit: 56, # Integer | Number of items to include in the response
242
+ page: 56 # Integer | Offset by this many pages, of the size of `limit`
183
243
  }
184
244
 
185
245
  begin
186
- #List URL signing keys
246
+ # List URL signing keys
187
247
  result = api_instance.list_url_signing_keys(opts)
188
248
  p result
189
249
  rescue MuxRuby::ApiError => e
190
- puts "Exception when calling URLSigningKeysApi->list_url_signing_keys: #{e}"
250
+ puts "Error when calling URLSigningKeysApi->list_url_signing_keys: #{e}"
251
+ end
252
+ ```
253
+
254
+ #### Using the list_url_signing_keys_with_http_info variant
255
+
256
+ This returns an Array which contains the response data, status code and headers.
257
+
258
+ > <Array(<ListSigningKeysResponse>, Integer, Hash)> list_url_signing_keys_with_http_info(opts)
259
+
260
+ ```ruby
261
+ begin
262
+ # List URL signing keys
263
+ data, status_code, headers = api_instance.list_url_signing_keys_with_http_info(opts)
264
+ p status_code # => 2xx
265
+ p headers # => { ... }
266
+ p data # => <ListSigningKeysResponse>
267
+ rescue MuxRuby::ApiError => e
268
+ puts "Error when calling URLSigningKeysApi->list_url_signing_keys_with_http_info: #{e}"
191
269
  end
192
270
  ```
193
271
 
194
272
  ### Parameters
195
273
 
196
- Name | Type | Description | Notes
197
- ------------- | ------------- | ------------- | -------------
198
- **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
199
- **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
274
+ | Name | Type | Description | Notes |
275
+ | ---- | ---- | ----------- | ----- |
276
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
277
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
200
278
 
201
279
  ### Return type
202
280
 
@@ -208,8 +286,6 @@ Name | Type | Description | Notes
208
286
 
209
287
  ### HTTP request headers
210
288
 
211
- - **Content-Type**: Not defined
212
- - **Accept**: application/json
213
-
214
-
289
+ - **Content-Type**: Not defined
290
+ - **Accept**: application/json
215
291