mux_ruby 1.5.1 → 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 (317) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +26 -37
  4. data/README.md +38 -12
  5. data/docs/AbridgedVideoView.md +33 -13
  6. data/docs/Asset.md +57 -23
  7. data/docs/AssetErrors.md +15 -4
  8. data/docs/AssetMaster.md +15 -4
  9. data/docs/AssetNonStandardInputReasons.md +34 -0
  10. data/docs/AssetRecordingTimes.md +20 -0
  11. data/docs/AssetResponse.md +13 -3
  12. data/docs/AssetStaticRenditions.md +15 -4
  13. data/docs/AssetStaticRenditionsFiles.md +23 -8
  14. data/docs/AssetsApi.md +391 -160
  15. data/docs/BreakdownValue.md +21 -7
  16. data/docs/CreateAssetRequest.md +27 -10
  17. data/docs/CreateLiveStreamRequest.md +25 -8
  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 +20 -0
  27. data/docs/DimensionsApi.md +156 -0
  28. data/docs/DirectUploadsApi.md +131 -56
  29. data/docs/DisableLiveStreamResponse.md +18 -0
  30. data/docs/EnableLiveStreamResponse.md +18 -0
  31. data/docs/Error.md +27 -10
  32. data/docs/ErrorsApi.md +37 -19
  33. data/docs/ExportsApi.md +32 -13
  34. data/docs/FilterValue.md +15 -4
  35. data/docs/FiltersApi.md +73 -35
  36. data/docs/GetAssetInputInfoResponse.md +13 -3
  37. data/docs/GetAssetOrLiveStreamIdResponse.md +18 -0
  38. data/docs/GetAssetOrLiveStreamIdResponseData.md +22 -0
  39. data/docs/GetAssetOrLiveStreamIdResponseDataObject.md +20 -0
  40. data/docs/GetAssetPlaybackIDResponse.md +13 -3
  41. data/docs/GetMetricTimeseriesDataResponse.md +17 -5
  42. data/docs/GetOverallValuesResponse.md +17 -5
  43. data/docs/GetRealTimeBreakdownResponse.md +22 -0
  44. data/docs/GetRealTimeHistogramTimeseriesResponse.md +24 -0
  45. data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md +18 -0
  46. data/docs/GetRealTimeTimeseriesResponse.md +22 -0
  47. data/docs/Incident.md +58 -0
  48. data/docs/IncidentBreakdown.md +22 -0
  49. data/docs/IncidentNotification.md +22 -0
  50. data/docs/IncidentNotificationRule.md +26 -0
  51. data/docs/IncidentResponse.md +20 -0
  52. data/docs/IncidentsApi.md +242 -0
  53. data/docs/InputFile.md +15 -4
  54. data/docs/InputInfo.md +15 -4
  55. data/docs/InputSettings.md +31 -10
  56. data/docs/InputSettingsOverlaySettings.md +25 -9
  57. data/docs/InputTrack.md +29 -11
  58. data/docs/Insight.md +23 -8
  59. data/docs/ListAllMetricValuesResponse.md +17 -5
  60. data/docs/ListAssetsResponse.md +13 -3
  61. data/docs/ListBreakdownValuesResponse.md +17 -5
  62. data/docs/ListDeliveryUsageResponse.md +19 -6
  63. data/docs/ListDimensionValuesResponse.md +22 -0
  64. data/docs/ListDimensionsResponse.md +22 -0
  65. data/docs/ListErrorsResponse.md +17 -5
  66. data/docs/ListExportsResponse.md +17 -5
  67. data/docs/ListFilterValuesResponse.md +17 -5
  68. data/docs/ListFiltersResponse.md +17 -5
  69. data/docs/ListFiltersResponseData.md +15 -4
  70. data/docs/ListIncidentsResponse.md +22 -0
  71. data/docs/ListInsightsResponse.md +17 -5
  72. data/docs/ListLiveStreamsResponse.md +13 -3
  73. data/docs/ListRealTimeDimensionsResponse.md +22 -0
  74. data/docs/ListRealTimeDimensionsResponseData.md +20 -0
  75. data/docs/ListRealTimeMetricsResponse.md +22 -0
  76. data/docs/ListRelatedIncidentsResponse.md +22 -0
  77. data/docs/ListSigningKeysResponse.md +13 -3
  78. data/docs/ListUploadsResponse.md +13 -3
  79. data/docs/ListVideoViewsResponse.md +17 -5
  80. data/docs/LiveStream.md +37 -15
  81. data/docs/LiveStreamResponse.md +13 -3
  82. data/docs/LiveStreamsApi.md +497 -145
  83. data/docs/Metric.md +21 -7
  84. data/docs/MetricsApi.md +206 -112
  85. data/docs/NotificationRule.md +22 -0
  86. data/docs/OverallValues.md +19 -6
  87. data/docs/PlaybackID.md +15 -4
  88. data/docs/PlaybackIDApi.md +78 -0
  89. data/docs/PlaybackPolicy.md +10 -2
  90. data/docs/RealTimeApi.md +376 -0
  91. data/docs/RealTimeBreakdownValue.md +26 -0
  92. data/docs/RealTimeHistogramTimeseriesBucket.md +20 -0
  93. data/docs/RealTimeHistogramTimeseriesBucketValues.md +20 -0
  94. data/docs/RealTimeHistogramTimeseriesDatapoint.md +30 -0
  95. data/docs/RealTimeTimeseriesDatapoint.md +22 -0
  96. data/docs/Score.md +23 -8
  97. data/docs/SignalLiveStreamCompleteResponse.md +13 -3
  98. data/docs/SigningKey.md +17 -5
  99. data/docs/SigningKeyResponse.md +13 -3
  100. data/docs/SimulcastTarget.md +21 -7
  101. data/docs/SimulcastTargetResponse.md +13 -3
  102. data/docs/Track.md +37 -15
  103. data/docs/URLSigningKeysApi.md +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 -112
  110. data/docs/VideoViewEvent.md +19 -6
  111. data/docs/VideoViewResponse.md +15 -4
  112. data/docs/VideoViewsApi.md +76 -39
  113. data/examples/data/exercise-dimensions.rb +29 -0
  114. data/examples/data/exercise-incidents.rb +29 -0
  115. data/examples/data/exercise-realtime.rb +60 -0
  116. data/examples/video/exercise-assets.rb +21 -0
  117. data/examples/video/exercise-live-streams.rb +30 -0
  118. data/gen/.gitignore +7 -0
  119. data/gen/Makefile +31 -0
  120. data/gen/generator-config.json +11 -0
  121. data/gen/openapitools.json +7 -0
  122. data/gen/package.json +17 -0
  123. data/gen/templates/Gemfile.mustache +11 -0
  124. data/gen/templates/README.mustache +158 -0
  125. data/gen/templates/Rakefile.mustache +10 -0
  126. data/gen/templates/api.mustache +206 -0
  127. data/gen/templates/api_client.mustache +264 -0
  128. data/gen/templates/api_client_faraday_partial.mustache +138 -0
  129. data/gen/templates/api_client_spec.mustache +220 -0
  130. data/gen/templates/api_client_typhoeus_partial.mustache +183 -0
  131. data/gen/templates/api_doc.mustache +118 -0
  132. data/gen/templates/api_error.mustache +67 -0
  133. data/gen/templates/api_info.mustache +12 -0
  134. data/gen/templates/api_test.mustache +47 -0
  135. data/gen/templates/base_object.mustache +120 -0
  136. data/gen/templates/configuration.mustache +349 -0
  137. data/gen/templates/configuration_spec.mustache +34 -0
  138. data/gen/templates/configuration_tls_faraday_partial.mustache +29 -0
  139. data/gen/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  140. data/gen/templates/gem.mustache +40 -0
  141. data/gen/templates/gemspec.mustache +35 -0
  142. data/gen/templates/gitignore.mustache +39 -0
  143. data/gen/templates/model.mustache +26 -0
  144. data/gen/templates/model_doc.mustache +12 -0
  145. data/gen/templates/model_test.mustache +77 -0
  146. data/gen/templates/partial_model_enum_class.mustache +20 -0
  147. data/gen/templates/partial_model_generic.mustache +371 -0
  148. data/gen/templates/partial_model_generic_doc.mustache +28 -0
  149. data/gen/templates/partial_oneof_module.mustache +137 -0
  150. data/gen/templates/partial_oneof_module_doc.mustache +92 -0
  151. data/gen/templates/rspec.mustache +2 -0
  152. data/gen/templates/rubocop.mustache +148 -0
  153. data/gen/templates/spec_helper.mustache +103 -0
  154. data/gen/templates/version.mustache +7 -0
  155. data/gen/yarn.lock +1878 -0
  156. data/lib/mux_ruby.rb +43 -2
  157. data/lib/mux_ruby/api/assets_api.rb +283 -150
  158. data/lib/mux_ruby/api/delivery_usage_api.rb +28 -12
  159. data/lib/mux_ruby/api/dimensions_api.rb +154 -0
  160. data/lib/mux_ruby/api/direct_uploads_api.rb +90 -44
  161. data/lib/mux_ruby/api/errors_api.rb +32 -16
  162. data/lib/mux_ruby/api/exports_api.rb +28 -12
  163. data/lib/mux_ruby/api/filters_api.rb +57 -31
  164. data/lib/mux_ruby/api/incidents_api.rb +259 -0
  165. data/lib/mux_ruby/api/live_streams_api.rb +381 -133
  166. data/lib/mux_ruby/api/metrics_api.rb +175 -104
  167. data/lib/mux_ruby/api/playback_id_api.rb +85 -0
  168. data/lib/mux_ruby/api/real_time_api.rb +373 -0
  169. data/lib/mux_ruby/api/url_signing_keys_api.rb +89 -42
  170. data/lib/mux_ruby/api/video_views_api.rb +56 -29
  171. data/lib/mux_ruby/api_client.rb +106 -91
  172. data/lib/mux_ruby/api_error.rb +35 -7
  173. data/lib/mux_ruby/configuration.rb +50 -14
  174. data/lib/mux_ruby/models/abridged_video_view.rb +58 -24
  175. data/lib/mux_ruby/models/asset.rb +147 -53
  176. data/lib/mux_ruby/models/asset_errors.rb +52 -15
  177. data/lib/mux_ruby/models/asset_master.rb +85 -15
  178. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +370 -0
  179. data/lib/mux_ruby/models/asset_recording_times.rb +229 -0
  180. data/lib/mux_ruby/models/asset_response.rb +48 -14
  181. data/lib/mux_ruby/models/asset_static_renditions.rb +55 -19
  182. data/lib/mux_ruby/models/asset_static_renditions_files.rb +60 -25
  183. data/lib/mux_ruby/models/breakdown_value.rb +52 -18
  184. data/lib/mux_ruby/models/create_asset_request.rb +70 -30
  185. data/lib/mux_ruby/models/create_live_stream_request.rb +70 -24
  186. data/lib/mux_ruby/models/create_playback_id_request.rb +48 -14
  187. data/lib/mux_ruby/models/create_playback_id_response.rb +48 -14
  188. data/lib/mux_ruby/models/create_simulcast_target_request.rb +50 -16
  189. data/lib/mux_ruby/models/create_track_request.rb +65 -27
  190. data/lib/mux_ruby/models/create_track_response.rb +48 -14
  191. data/lib/mux_ruby/models/create_upload_request.rb +52 -18
  192. data/lib/mux_ruby/models/delivery_report.rb +106 -21
  193. data/lib/mux_ruby/models/dimension_value.rb +227 -0
  194. data/lib/mux_ruby/models/disable_live_stream_response.rb +218 -0
  195. data/lib/mux_ruby/models/enable_live_stream_response.rb +218 -0
  196. data/lib/mux_ruby/models/error.rb +63 -21
  197. data/lib/mux_ruby/models/filter_value.rb +49 -15
  198. data/lib/mux_ruby/models/get_asset_input_info_response.rb +48 -14
  199. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +218 -0
  200. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +237 -0
  201. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +264 -0
  202. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +48 -14
  203. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +50 -16
  204. data/lib/mux_ruby/models/get_overall_values_response.rb +50 -16
  205. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +240 -0
  206. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +249 -0
  207. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +220 -0
  208. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +240 -0
  209. data/lib/mux_ruby/models/incident.rb +404 -0
  210. data/lib/mux_ruby/models/incident_breakdown.rb +236 -0
  211. data/lib/mux_ruby/models/incident_notification.rb +236 -0
  212. data/lib/mux_ruby/models/incident_notification_rule.rb +256 -0
  213. data/lib/mux_ruby/models/incident_response.rb +229 -0
  214. data/lib/mux_ruby/models/input_file.rb +49 -15
  215. data/lib/mux_ruby/models/input_info.rb +49 -15
  216. data/lib/mux_ruby/models/input_settings.rb +91 -30
  217. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +68 -26
  218. data/lib/mux_ruby/models/input_track.rb +56 -22
  219. data/lib/mux_ruby/models/insight.rb +53 -19
  220. data/lib/mux_ruby/models/list_all_metric_values_response.rb +50 -16
  221. data/lib/mux_ruby/models/list_assets_response.rb +48 -14
  222. data/lib/mux_ruby/models/list_breakdown_values_response.rb +50 -16
  223. data/lib/mux_ruby/models/list_delivery_usage_response.rb +51 -17
  224. data/lib/mux_ruby/models/list_dimension_values_response.rb +240 -0
  225. data/lib/mux_ruby/models/list_dimensions_response.rb +238 -0
  226. data/lib/mux_ruby/models/list_errors_response.rb +50 -16
  227. data/lib/mux_ruby/models/list_exports_response.rb +50 -16
  228. data/lib/mux_ruby/models/list_filter_values_response.rb +50 -16
  229. data/lib/mux_ruby/models/list_filters_response.rb +50 -16
  230. data/lib/mux_ruby/models/list_filters_response_data.rb +49 -15
  231. data/lib/mux_ruby/models/list_incidents_response.rb +240 -0
  232. data/lib/mux_ruby/models/list_insights_response.rb +50 -16
  233. data/lib/mux_ruby/models/list_live_streams_response.rb +48 -14
  234. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +240 -0
  235. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +227 -0
  236. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +240 -0
  237. data/lib/mux_ruby/models/list_related_incidents_response.rb +240 -0
  238. data/lib/mux_ruby/models/list_signing_keys_response.rb +48 -14
  239. data/lib/mux_ruby/models/list_uploads_response.rb +48 -14
  240. data/lib/mux_ruby/models/list_video_views_response.rb +50 -16
  241. data/lib/mux_ruby/models/live_stream.rb +111 -29
  242. data/lib/mux_ruby/models/live_stream_response.rb +48 -14
  243. data/lib/mux_ruby/models/metric.rb +52 -18
  244. data/lib/mux_ruby/models/notification_rule.rb +236 -0
  245. data/lib/mux_ruby/models/overall_values.rb +51 -17
  246. data/lib/mux_ruby/models/playback_id.rb +50 -15
  247. data/lib/mux_ruby/models/playback_policy.rb +12 -6
  248. data/lib/mux_ruby/models/real_time_breakdown_value.rb +254 -0
  249. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +227 -0
  250. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +227 -0
  251. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +274 -0
  252. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +236 -0
  253. data/lib/mux_ruby/models/score.rb +53 -19
  254. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +48 -14
  255. data/lib/mux_ruby/models/signing_key.rb +53 -16
  256. data/lib/mux_ruby/models/signing_key_response.rb +48 -14
  257. data/lib/mux_ruby/models/simulcast_target.rb +55 -21
  258. data/lib/mux_ruby/models/simulcast_target_response.rb +48 -14
  259. data/lib/mux_ruby/models/track.rb +92 -33
  260. data/lib/mux_ruby/models/update_asset_master_access_request.rb +51 -17
  261. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +51 -17
  262. data/lib/mux_ruby/models/upload.rb +62 -26
  263. data/lib/mux_ruby/models/upload_error.rb +51 -15
  264. data/lib/mux_ruby/models/upload_response.rb +48 -14
  265. data/lib/mux_ruby/models/video_view.rb +200 -148
  266. data/lib/mux_ruby/models/video_view_event.rb +51 -17
  267. data/lib/mux_ruby/models/video_view_response.rb +49 -15
  268. data/lib/mux_ruby/version.rb +10 -3
  269. data/mux_ruby.gemspec +15 -15
  270. data/spec/api/assets_api_spec.rb +2 -0
  271. data/spec/api/dimensions_api_spec.rb +55 -0
  272. data/spec/api/filters_api_spec.rb +2 -2
  273. data/spec/api/incidents_api_spec.rb +73 -0
  274. data/spec/api/live_streams_api_spec.rb +24 -0
  275. data/spec/api/playback_id_api_spec.rb +40 -0
  276. data/spec/api/real_time_api_spec.rb +93 -0
  277. data/spec/api_client_spec.rb +10 -3
  278. data/spec/configuration_spec.rb +9 -2
  279. data/spec/models/asset_master_spec.rb +4 -0
  280. data/spec/models/asset_non_standard_input_reasons_spec.rb +98 -0
  281. data/spec/models/asset_recording_times_spec.rb +40 -0
  282. data/spec/models/asset_spec.rb +26 -0
  283. data/spec/models/asset_static_renditions_files_spec.rb +2 -2
  284. data/spec/models/create_live_stream_request_spec.rb +6 -0
  285. data/spec/models/dimension_value_spec.rb +40 -0
  286. data/spec/models/disable_live_stream_response_spec.rb +34 -0
  287. data/spec/models/enable_live_stream_response_spec.rb +34 -0
  288. data/spec/models/get_asset_or_live_stream_id_response_data_object_spec.rb +44 -0
  289. data/spec/models/get_asset_or_live_stream_id_response_data_spec.rb +46 -0
  290. data/spec/models/get_asset_or_live_stream_id_response_spec.rb +34 -0
  291. data/spec/models/get_real_time_breakdown_response_spec.rb +46 -0
  292. data/spec/models/get_real_time_histogram_timeseries_response_meta_spec.rb +34 -0
  293. data/spec/models/get_real_time_histogram_timeseries_response_spec.rb +52 -0
  294. data/spec/models/get_real_time_timeseries_response_spec.rb +46 -0
  295. data/spec/models/incident_breakdown_spec.rb +46 -0
  296. data/spec/models/incident_notification_rule_spec.rb +58 -0
  297. data/spec/models/incident_notification_spec.rb +46 -0
  298. data/spec/models/incident_response_spec.rb +40 -0
  299. data/spec/models/incident_spec.rb +154 -0
  300. data/spec/models/input_settings_spec.rb +12 -0
  301. data/spec/models/list_dimension_values_response_spec.rb +46 -0
  302. data/spec/models/list_dimensions_response_spec.rb +46 -0
  303. data/spec/models/list_incidents_response_spec.rb +46 -0
  304. data/spec/models/list_real_time_dimensions_response_data_spec.rb +40 -0
  305. data/spec/models/list_real_time_dimensions_response_spec.rb +46 -0
  306. data/spec/models/list_real_time_metrics_response_spec.rb +46 -0
  307. data/spec/models/list_related_incidents_response_spec.rb +46 -0
  308. data/spec/models/notification_rule_spec.rb +46 -0
  309. data/spec/models/real_time_breakdown_value_spec.rb +58 -0
  310. data/spec/models/real_time_histogram_timeseries_bucket_spec.rb +40 -0
  311. data/spec/models/real_time_histogram_timeseries_bucket_values_spec.rb +40 -0
  312. data/spec/models/real_time_histogram_timeseries_datapoint_spec.rb +70 -0
  313. data/spec/models/real_time_timeseries_datapoint_spec.rb +46 -0
  314. data/spec/models/track_spec.rb +4 -0
  315. data/spec/models/video_view_spec.rb +12 -0
  316. data/spec/spec_helper.rb +9 -2
  317. metadata +249 -212
@@ -1,8 +1,18 @@
1
1
  # MuxRuby::AssetResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Asset**](.md) | | [optional]
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Asset**](.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::AssetResponse.new(
15
+ data: null
16
+ )
17
+ ```
8
18
 
@@ -1,9 +1,20 @@
1
1
  # MuxRuby::AssetStaticRenditions
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **status** | **String** | * `ready`: All MP4s are downloadable * `preparing`: We are preparing the MP4s * `disabled`: MP4 support was not requested or has been removed * `errored`: There was a Mux internal error that prevented the MP4s from being created | [optional] [default to 'disabled']
7
- **files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | Indicates the status of downloadable MP4 versions of this asset. | [optional][default to 'disabled'] |
8
+ | **files** | [**Array<AssetStaticRenditionsFiles>**](AssetStaticRenditionsFiles.md) | Array of file objects. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::AssetStaticRenditions.new(
16
+ status: null,
17
+ files: null
18
+ )
19
+ ```
9
20
 
@@ -1,13 +1,28 @@
1
1
  # MuxRuby::AssetStaticRenditionsFiles
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | | [optional]
7
- **ext** | **String** | Extension of the static rendition file | [optional]
8
- **height** | **Integer** | The height of the static rendition's file in pixels | [optional]
9
- **width** | **Integer** | The width of the static rendition's file in pixels | [optional]
10
- **bitrate** | **Integer** | The bitrate in bits per second | [optional]
11
- **filesize** | **String** | | [optional]
12
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **ext** | **String** | Extension of the static rendition file | [optional] |
9
+ | **height** | **Integer** | The height of the static rendition's file in pixels | [optional] |
10
+ | **width** | **Integer** | The width of the static rendition's file in pixels | [optional] |
11
+ | **bitrate** | **Integer** | The bitrate in bits per second | [optional] |
12
+ | **filesize** | **String** | The file size in bytes | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'mux_ruby'
18
+
19
+ instance = MuxRuby::AssetStaticRenditionsFiles.new(
20
+ name: null,
21
+ ext: null,
22
+ height: null,
23
+ width: null,
24
+ bitrate: null,
25
+ filesize: null
26
+ )
27
+ ```
13
28
 
data/docs/AssetsApi.md CHANGED
@@ -2,32 +2,34 @@
2
2
 
3
3
  All URIs are relative to *https://api.mux.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset
8
- [**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
9
- [**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
10
- [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset
11
- [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
12
- [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
13
- [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset
14
- [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
15
- [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
16
- [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets
17
- [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
18
- [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
19
-
20
-
21
- # **create_asset**
22
- > AssetResponse create_asset(create_asset_request)
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_asset**](AssetsApi.md#create_asset) | **POST** /video/v1/assets | Create an asset |
8
+ | [**create_asset_playback_id**](AssetsApi.md#create_asset_playback_id) | **POST** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID |
9
+ | [**create_asset_track**](AssetsApi.md#create_asset_track) | **POST** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track |
10
+ | [**delete_asset**](AssetsApi.md#delete_asset) | **DELETE** /video/v1/assets/{ASSET_ID} | Delete an asset |
11
+ | [**delete_asset_playback_id**](AssetsApi.md#delete_asset_playback_id) | **DELETE** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID |
12
+ | [**delete_asset_track**](AssetsApi.md#delete_asset_track) | **DELETE** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track |
13
+ | [**get_asset**](AssetsApi.md#get_asset) | **GET** /video/v1/assets/{ASSET_ID} | Retrieve an asset |
14
+ | [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info |
15
+ | [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID |
16
+ | [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets |
17
+ | [**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access |
18
+ | [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support |
19
+
20
+
21
+ ## create_asset
22
+
23
+ > <AssetResponse> create_asset(create_asset_request)
23
24
 
24
25
  Create an asset
25
26
 
26
27
  Create a new Mux Video asset.
27
28
 
28
- ### Example
29
+ ### Examples
30
+
29
31
  ```ruby
30
- # load the gem
32
+ require 'time'
31
33
  require 'mux_ruby'
32
34
  # setup authorization
33
35
  MuxRuby.configure do |config|
@@ -40,19 +42,37 @@ api_instance = MuxRuby::AssetsApi.new
40
42
  create_asset_request = MuxRuby::CreateAssetRequest.new # CreateAssetRequest |
41
43
 
42
44
  begin
43
- #Create an asset
45
+ # Create an asset
44
46
  result = api_instance.create_asset(create_asset_request)
45
47
  p result
46
48
  rescue MuxRuby::ApiError => e
47
- puts "Exception when calling AssetsApi->create_asset: #{e}"
49
+ puts "Error when calling AssetsApi->create_asset: #{e}"
50
+ end
51
+ ```
52
+
53
+ #### Using the create_asset_with_http_info variant
54
+
55
+ This returns an Array which contains the response data, status code and headers.
56
+
57
+ > <Array(<AssetResponse>, Integer, Hash)> create_asset_with_http_info(create_asset_request)
58
+
59
+ ```ruby
60
+ begin
61
+ # Create an asset
62
+ data, status_code, headers = api_instance.create_asset_with_http_info(create_asset_request)
63
+ p status_code # => 2xx
64
+ p headers # => { ... }
65
+ p data # => <AssetResponse>
66
+ rescue MuxRuby::ApiError => e
67
+ puts "Error when calling AssetsApi->create_asset_with_http_info: #{e}"
48
68
  end
49
69
  ```
50
70
 
51
71
  ### Parameters
52
72
 
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **create_asset_request** | [**CreateAssetRequest**](CreateAssetRequest.md)| |
73
+ | Name | Type | Description | Notes |
74
+ | ---- | ---- | ----------- | ----- |
75
+ | **create_asset_request** | [**CreateAssetRequest**](CreateAssetRequest.md) | | |
56
76
 
57
77
  ### Return type
58
78
 
@@ -64,19 +84,20 @@ Name | Type | Description | Notes
64
84
 
65
85
  ### HTTP request headers
66
86
 
67
- - **Content-Type**: application/json
68
- - **Accept**: application/json
87
+ - **Content-Type**: application/json
88
+ - **Accept**: application/json
69
89
 
70
90
 
91
+ ## create_asset_playback_id
71
92
 
72
- # **create_asset_playback_id**
73
- > CreatePlaybackIDResponse create_asset_playback_id(asset_id, create_playback_id_request)
93
+ > <CreatePlaybackIDResponse> create_asset_playback_id(asset_id, create_playback_id_request)
74
94
 
75
95
  Create a playback ID
76
96
 
77
- ### Example
97
+ ### Examples
98
+
78
99
  ```ruby
79
- # load the gem
100
+ require 'time'
80
101
  require 'mux_ruby'
81
102
  # setup authorization
82
103
  MuxRuby.configure do |config|
@@ -90,20 +111,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
90
111
  create_playback_id_request = MuxRuby::CreatePlaybackIDRequest.new # CreatePlaybackIDRequest |
91
112
 
92
113
  begin
93
- #Create a playback ID
114
+ # Create a playback ID
94
115
  result = api_instance.create_asset_playback_id(asset_id, create_playback_id_request)
95
116
  p result
96
117
  rescue MuxRuby::ApiError => e
97
- puts "Exception when calling AssetsApi->create_asset_playback_id: #{e}"
118
+ puts "Error when calling AssetsApi->create_asset_playback_id: #{e}"
119
+ end
120
+ ```
121
+
122
+ #### Using the create_asset_playback_id_with_http_info variant
123
+
124
+ This returns an Array which contains the response data, status code and headers.
125
+
126
+ > <Array(<CreatePlaybackIDResponse>, Integer, Hash)> create_asset_playback_id_with_http_info(asset_id, create_playback_id_request)
127
+
128
+ ```ruby
129
+ begin
130
+ # Create a playback ID
131
+ data, status_code, headers = api_instance.create_asset_playback_id_with_http_info(asset_id, create_playback_id_request)
132
+ p status_code # => 2xx
133
+ p headers # => { ... }
134
+ p data # => <CreatePlaybackIDResponse>
135
+ rescue MuxRuby::ApiError => e
136
+ puts "Error when calling AssetsApi->create_asset_playback_id_with_http_info: #{e}"
98
137
  end
99
138
  ```
100
139
 
101
140
  ### Parameters
102
141
 
103
- Name | Type | Description | Notes
104
- ------------- | ------------- | ------------- | -------------
105
- **asset_id** | **String**| The asset ID. |
106
- **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md)| |
142
+ | Name | Type | Description | Notes |
143
+ | ---- | ---- | ----------- | ----- |
144
+ | **asset_id** | **String** | The asset ID. | |
145
+ | **create_playback_id_request** | [**CreatePlaybackIDRequest**](CreatePlaybackIDRequest.md) | | |
107
146
 
108
147
  ### Return type
109
148
 
@@ -115,19 +154,20 @@ Name | Type | Description | Notes
115
154
 
116
155
  ### HTTP request headers
117
156
 
118
- - **Content-Type**: application/json
119
- - **Accept**: application/json
157
+ - **Content-Type**: application/json
158
+ - **Accept**: application/json
120
159
 
121
160
 
161
+ ## create_asset_track
122
162
 
123
- # **create_asset_track**
124
- > CreateTrackResponse create_asset_track(asset_id, create_track_request)
163
+ > <CreateTrackResponse> create_asset_track(asset_id, create_track_request)
125
164
 
126
165
  Create an asset track
127
166
 
128
- ### Example
167
+ ### Examples
168
+
129
169
  ```ruby
130
- # load the gem
170
+ require 'time'
131
171
  require 'mux_ruby'
132
172
  # setup authorization
133
173
  MuxRuby.configure do |config|
@@ -138,23 +178,41 @@ end
138
178
 
139
179
  api_instance = MuxRuby::AssetsApi.new
140
180
  asset_id = 'asset_id_example' # String | The asset ID.
141
- create_track_request = MuxRuby::CreateTrackRequest.new # CreateTrackRequest |
181
+ create_track_request = MuxRuby::CreateTrackRequest.new({url: 'url_example', type: 'text', text_type: 'subtitles', language_code: 'language_code_example'}) # CreateTrackRequest |
142
182
 
143
183
  begin
144
- #Create an asset track
184
+ # Create an asset track
145
185
  result = api_instance.create_asset_track(asset_id, create_track_request)
146
186
  p result
147
187
  rescue MuxRuby::ApiError => e
148
- puts "Exception when calling AssetsApi->create_asset_track: #{e}"
188
+ puts "Error when calling AssetsApi->create_asset_track: #{e}"
189
+ end
190
+ ```
191
+
192
+ #### Using the create_asset_track_with_http_info variant
193
+
194
+ This returns an Array which contains the response data, status code and headers.
195
+
196
+ > <Array(<CreateTrackResponse>, Integer, Hash)> create_asset_track_with_http_info(asset_id, create_track_request)
197
+
198
+ ```ruby
199
+ begin
200
+ # Create an asset track
201
+ data, status_code, headers = api_instance.create_asset_track_with_http_info(asset_id, create_track_request)
202
+ p status_code # => 2xx
203
+ p headers # => { ... }
204
+ p data # => <CreateTrackResponse>
205
+ rescue MuxRuby::ApiError => e
206
+ puts "Error when calling AssetsApi->create_asset_track_with_http_info: #{e}"
149
207
  end
150
208
  ```
151
209
 
152
210
  ### Parameters
153
211
 
154
- Name | Type | Description | Notes
155
- ------------- | ------------- | ------------- | -------------
156
- **asset_id** | **String**| The asset ID. |
157
- **create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md)| |
212
+ | Name | Type | Description | Notes |
213
+ | ---- | ---- | ----------- | ----- |
214
+ | **asset_id** | **String** | The asset ID. | |
215
+ | **create_track_request** | [**CreateTrackRequest**](CreateTrackRequest.md) | | |
158
216
 
159
217
  ### Return type
160
218
 
@@ -166,19 +224,22 @@ Name | Type | Description | Notes
166
224
 
167
225
  ### HTTP request headers
168
226
 
169
- - **Content-Type**: application/json
170
- - **Accept**: application/json
227
+ - **Content-Type**: application/json
228
+ - **Accept**: application/json
171
229
 
172
230
 
231
+ ## delete_asset
173
232
 
174
- # **delete_asset**
175
233
  > delete_asset(asset_id)
176
234
 
177
235
  Delete an asset
178
236
 
179
- ### Example
237
+ Deletes a video asset and all its data
238
+
239
+ ### Examples
240
+
180
241
  ```ruby
181
- # load the gem
242
+ require 'time'
182
243
  require 'mux_ruby'
183
244
  # setup authorization
184
245
  MuxRuby.configure do |config|
@@ -191,18 +252,36 @@ api_instance = MuxRuby::AssetsApi.new
191
252
  asset_id = 'asset_id_example' # String | The asset ID.
192
253
 
193
254
  begin
194
- #Delete an asset
255
+ # Delete an asset
195
256
  api_instance.delete_asset(asset_id)
196
257
  rescue MuxRuby::ApiError => e
197
- puts "Exception when calling AssetsApi->delete_asset: #{e}"
258
+ puts "Error when calling AssetsApi->delete_asset: #{e}"
259
+ end
260
+ ```
261
+
262
+ #### Using the delete_asset_with_http_info variant
263
+
264
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
265
+
266
+ > <Array(nil, Integer, Hash)> delete_asset_with_http_info(asset_id)
267
+
268
+ ```ruby
269
+ begin
270
+ # Delete an asset
271
+ data, status_code, headers = api_instance.delete_asset_with_http_info(asset_id)
272
+ p status_code # => 2xx
273
+ p headers # => { ... }
274
+ p data # => nil
275
+ rescue MuxRuby::ApiError => e
276
+ puts "Error when calling AssetsApi->delete_asset_with_http_info: #{e}"
198
277
  end
199
278
  ```
200
279
 
201
280
  ### Parameters
202
281
 
203
- Name | Type | Description | Notes
204
- ------------- | ------------- | ------------- | -------------
205
- **asset_id** | **String**| The asset ID. |
282
+ | Name | Type | Description | Notes |
283
+ | ---- | ---- | ----------- | ----- |
284
+ | **asset_id** | **String** | The asset ID. | |
206
285
 
207
286
  ### Return type
208
287
 
@@ -214,19 +293,20 @@ nil (empty response body)
214
293
 
215
294
  ### HTTP request headers
216
295
 
217
- - **Content-Type**: Not defined
218
- - **Accept**: Not defined
296
+ - **Content-Type**: Not defined
297
+ - **Accept**: Not defined
219
298
 
220
299
 
300
+ ## delete_asset_playback_id
221
301
 
222
- # **delete_asset_playback_id**
223
302
  > delete_asset_playback_id(asset_id, playback_id)
224
303
 
225
304
  Delete a playback ID
226
305
 
227
- ### Example
306
+ ### Examples
307
+
228
308
  ```ruby
229
- # load the gem
309
+ require 'time'
230
310
  require 'mux_ruby'
231
311
  # setup authorization
232
312
  MuxRuby.configure do |config|
@@ -240,19 +320,37 @@ asset_id = 'asset_id_example' # String | The asset ID.
240
320
  playback_id = 'playback_id_example' # String | The live stream's playback ID.
241
321
 
242
322
  begin
243
- #Delete a playback ID
323
+ # Delete a playback ID
244
324
  api_instance.delete_asset_playback_id(asset_id, playback_id)
245
325
  rescue MuxRuby::ApiError => e
246
- puts "Exception when calling AssetsApi->delete_asset_playback_id: #{e}"
326
+ puts "Error when calling AssetsApi->delete_asset_playback_id: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the delete_asset_playback_id_with_http_info variant
331
+
332
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
333
+
334
+ > <Array(nil, Integer, Hash)> delete_asset_playback_id_with_http_info(asset_id, playback_id)
335
+
336
+ ```ruby
337
+ begin
338
+ # Delete a playback ID
339
+ data, status_code, headers = api_instance.delete_asset_playback_id_with_http_info(asset_id, playback_id)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => nil
343
+ rescue MuxRuby::ApiError => e
344
+ puts "Error when calling AssetsApi->delete_asset_playback_id_with_http_info: #{e}"
247
345
  end
248
346
  ```
249
347
 
250
348
  ### Parameters
251
349
 
252
- Name | Type | Description | Notes
253
- ------------- | ------------- | ------------- | -------------
254
- **asset_id** | **String**| The asset ID. |
255
- **playback_id** | **String**| The live stream&#39;s playback ID. |
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **asset_id** | **String** | The asset ID. | |
353
+ | **playback_id** | **String** | The live stream&#39;s playback ID. | |
256
354
 
257
355
  ### Return type
258
356
 
@@ -264,19 +362,20 @@ nil (empty response body)
264
362
 
265
363
  ### HTTP request headers
266
364
 
267
- - **Content-Type**: Not defined
268
- - **Accept**: Not defined
365
+ - **Content-Type**: Not defined
366
+ - **Accept**: Not defined
269
367
 
270
368
 
369
+ ## delete_asset_track
271
370
 
272
- # **delete_asset_track**
273
371
  > delete_asset_track(asset_id, track_id)
274
372
 
275
373
  Delete an asset track
276
374
 
277
- ### Example
375
+ ### Examples
376
+
278
377
  ```ruby
279
- # load the gem
378
+ require 'time'
280
379
  require 'mux_ruby'
281
380
  # setup authorization
282
381
  MuxRuby.configure do |config|
@@ -290,19 +389,37 @@ asset_id = 'asset_id_example' # String | The asset ID.
290
389
  track_id = 'track_id_example' # String | The track ID.
291
390
 
292
391
  begin
293
- #Delete an asset track
392
+ # Delete an asset track
294
393
  api_instance.delete_asset_track(asset_id, track_id)
295
394
  rescue MuxRuby::ApiError => e
296
- puts "Exception when calling AssetsApi->delete_asset_track: #{e}"
395
+ puts "Error when calling AssetsApi->delete_asset_track: #{e}"
396
+ end
397
+ ```
398
+
399
+ #### Using the delete_asset_track_with_http_info variant
400
+
401
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
402
+
403
+ > <Array(nil, Integer, Hash)> delete_asset_track_with_http_info(asset_id, track_id)
404
+
405
+ ```ruby
406
+ begin
407
+ # Delete an asset track
408
+ data, status_code, headers = api_instance.delete_asset_track_with_http_info(asset_id, track_id)
409
+ p status_code # => 2xx
410
+ p headers # => { ... }
411
+ p data # => nil
412
+ rescue MuxRuby::ApiError => e
413
+ puts "Error when calling AssetsApi->delete_asset_track_with_http_info: #{e}"
297
414
  end
298
415
  ```
299
416
 
300
417
  ### Parameters
301
418
 
302
- Name | Type | Description | Notes
303
- ------------- | ------------- | ------------- | -------------
304
- **asset_id** | **String**| The asset ID. |
305
- **track_id** | **String**| The track ID. |
419
+ | Name | Type | Description | Notes |
420
+ | ---- | ---- | ----------- | ----- |
421
+ | **asset_id** | **String** | The asset ID. | |
422
+ | **track_id** | **String** | The track ID. | |
306
423
 
307
424
  ### Return type
308
425
 
@@ -314,21 +431,22 @@ nil (empty response body)
314
431
 
315
432
  ### HTTP request headers
316
433
 
317
- - **Content-Type**: Not defined
318
- - **Accept**: Not defined
434
+ - **Content-Type**: Not defined
435
+ - **Accept**: Not defined
319
436
 
320
437
 
438
+ ## get_asset
321
439
 
322
- # **get_asset**
323
- > AssetResponse get_asset(asset_id)
440
+ > <AssetResponse> get_asset(asset_id)
324
441
 
325
442
  Retrieve an asset
326
443
 
327
444
  Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.
328
445
 
329
- ### Example
446
+ ### Examples
447
+
330
448
  ```ruby
331
- # load the gem
449
+ require 'time'
332
450
  require 'mux_ruby'
333
451
  # setup authorization
334
452
  MuxRuby.configure do |config|
@@ -341,19 +459,37 @@ api_instance = MuxRuby::AssetsApi.new
341
459
  asset_id = 'asset_id_example' # String | The asset ID.
342
460
 
343
461
  begin
344
- #Retrieve an asset
462
+ # Retrieve an asset
345
463
  result = api_instance.get_asset(asset_id)
346
464
  p result
347
465
  rescue MuxRuby::ApiError => e
348
- puts "Exception when calling AssetsApi->get_asset: #{e}"
466
+ puts "Error when calling AssetsApi->get_asset: #{e}"
467
+ end
468
+ ```
469
+
470
+ #### Using the get_asset_with_http_info variant
471
+
472
+ This returns an Array which contains the response data, status code and headers.
473
+
474
+ > <Array(<AssetResponse>, Integer, Hash)> get_asset_with_http_info(asset_id)
475
+
476
+ ```ruby
477
+ begin
478
+ # Retrieve an asset
479
+ data, status_code, headers = api_instance.get_asset_with_http_info(asset_id)
480
+ p status_code # => 2xx
481
+ p headers # => { ... }
482
+ p data # => <AssetResponse>
483
+ rescue MuxRuby::ApiError => e
484
+ puts "Error when calling AssetsApi->get_asset_with_http_info: #{e}"
349
485
  end
350
486
  ```
351
487
 
352
488
  ### Parameters
353
489
 
354
- Name | Type | Description | Notes
355
- ------------- | ------------- | ------------- | -------------
356
- **asset_id** | **String**| The asset ID. |
490
+ | Name | Type | Description | Notes |
491
+ | ---- | ---- | ----------- | ----- |
492
+ | **asset_id** | **String** | The asset ID. | |
357
493
 
358
494
  ### Return type
359
495
 
@@ -365,21 +501,22 @@ Name | Type | Description | Notes
365
501
 
366
502
  ### HTTP request headers
367
503
 
368
- - **Content-Type**: Not defined
369
- - **Accept**: application/json
504
+ - **Content-Type**: Not defined
505
+ - **Accept**: application/json
370
506
 
371
507
 
508
+ ## get_asset_input_info
372
509
 
373
- # **get_asset_input_info**
374
- > GetAssetInputInfoResponse get_asset_input_info(asset_id)
510
+ > <GetAssetInputInfoResponse> get_asset_input_info(asset_id)
375
511
 
376
512
  Retrieve asset input info
377
513
 
378
514
  Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input.
379
515
 
380
- ### Example
516
+ ### Examples
517
+
381
518
  ```ruby
382
- # load the gem
519
+ require 'time'
383
520
  require 'mux_ruby'
384
521
  # setup authorization
385
522
  MuxRuby.configure do |config|
@@ -392,19 +529,37 @@ api_instance = MuxRuby::AssetsApi.new
392
529
  asset_id = 'asset_id_example' # String | The asset ID.
393
530
 
394
531
  begin
395
- #Retrieve asset input info
532
+ # Retrieve asset input info
396
533
  result = api_instance.get_asset_input_info(asset_id)
397
534
  p result
398
535
  rescue MuxRuby::ApiError => e
399
- puts "Exception when calling AssetsApi->get_asset_input_info: #{e}"
536
+ puts "Error when calling AssetsApi->get_asset_input_info: #{e}"
537
+ end
538
+ ```
539
+
540
+ #### Using the get_asset_input_info_with_http_info variant
541
+
542
+ This returns an Array which contains the response data, status code and headers.
543
+
544
+ > <Array(<GetAssetInputInfoResponse>, Integer, Hash)> get_asset_input_info_with_http_info(asset_id)
545
+
546
+ ```ruby
547
+ begin
548
+ # Retrieve asset input info
549
+ data, status_code, headers = api_instance.get_asset_input_info_with_http_info(asset_id)
550
+ p status_code # => 2xx
551
+ p headers # => { ... }
552
+ p data # => <GetAssetInputInfoResponse>
553
+ rescue MuxRuby::ApiError => e
554
+ puts "Error when calling AssetsApi->get_asset_input_info_with_http_info: #{e}"
400
555
  end
401
556
  ```
402
557
 
403
558
  ### Parameters
404
559
 
405
- Name | Type | Description | Notes
406
- ------------- | ------------- | ------------- | -------------
407
- **asset_id** | **String**| The asset ID. |
560
+ | Name | Type | Description | Notes |
561
+ | ---- | ---- | ----------- | ----- |
562
+ | **asset_id** | **String** | The asset ID. | |
408
563
 
409
564
  ### Return type
410
565
 
@@ -416,19 +571,20 @@ Name | Type | Description | Notes
416
571
 
417
572
  ### HTTP request headers
418
573
 
419
- - **Content-Type**: Not defined
420
- - **Accept**: application/json
574
+ - **Content-Type**: Not defined
575
+ - **Accept**: application/json
421
576
 
422
577
 
578
+ ## get_asset_playback_id
423
579
 
424
- # **get_asset_playback_id**
425
- > GetAssetPlaybackIDResponse get_asset_playback_id(asset_id, playback_id)
580
+ > <GetAssetPlaybackIDResponse> get_asset_playback_id(asset_id, playback_id)
426
581
 
427
582
  Retrieve a playback ID
428
583
 
429
- ### Example
584
+ ### Examples
585
+
430
586
  ```ruby
431
- # load the gem
587
+ require 'time'
432
588
  require 'mux_ruby'
433
589
  # setup authorization
434
590
  MuxRuby.configure do |config|
@@ -442,20 +598,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
442
598
  playback_id = 'playback_id_example' # String | The live stream's playback ID.
443
599
 
444
600
  begin
445
- #Retrieve a playback ID
601
+ # Retrieve a playback ID
446
602
  result = api_instance.get_asset_playback_id(asset_id, playback_id)
447
603
  p result
448
604
  rescue MuxRuby::ApiError => e
449
- puts "Exception when calling AssetsApi->get_asset_playback_id: #{e}"
605
+ puts "Error when calling AssetsApi->get_asset_playback_id: #{e}"
606
+ end
607
+ ```
608
+
609
+ #### Using the get_asset_playback_id_with_http_info variant
610
+
611
+ This returns an Array which contains the response data, status code and headers.
612
+
613
+ > <Array(<GetAssetPlaybackIDResponse>, Integer, Hash)> get_asset_playback_id_with_http_info(asset_id, playback_id)
614
+
615
+ ```ruby
616
+ begin
617
+ # Retrieve a playback ID
618
+ data, status_code, headers = api_instance.get_asset_playback_id_with_http_info(asset_id, playback_id)
619
+ p status_code # => 2xx
620
+ p headers # => { ... }
621
+ p data # => <GetAssetPlaybackIDResponse>
622
+ rescue MuxRuby::ApiError => e
623
+ puts "Error when calling AssetsApi->get_asset_playback_id_with_http_info: #{e}"
450
624
  end
451
625
  ```
452
626
 
453
627
  ### Parameters
454
628
 
455
- Name | Type | Description | Notes
456
- ------------- | ------------- | ------------- | -------------
457
- **asset_id** | **String**| The asset ID. |
458
- **playback_id** | **String**| The live stream&#39;s playback ID. |
629
+ | Name | Type | Description | Notes |
630
+ | ---- | ---- | ----------- | ----- |
631
+ | **asset_id** | **String** | The asset ID. | |
632
+ | **playback_id** | **String** | The live stream&#39;s playback ID. | |
459
633
 
460
634
  ### Return type
461
635
 
@@ -467,19 +641,22 @@ Name | Type | Description | Notes
467
641
 
468
642
  ### HTTP request headers
469
643
 
470
- - **Content-Type**: Not defined
471
- - **Accept**: application/json
644
+ - **Content-Type**: Not defined
645
+ - **Accept**: application/json
472
646
 
473
647
 
648
+ ## list_assets
474
649
 
475
- # **list_assets**
476
- > ListAssetsResponse list_assets(opts)
650
+ > <ListAssetsResponse> list_assets(opts)
477
651
 
478
652
  List assets
479
653
 
480
- ### Example
654
+ List all Mux assets.
655
+
656
+ ### Examples
657
+
481
658
  ```ruby
482
- # load the gem
659
+ require 'time'
483
660
  require 'mux_ruby'
484
661
  # setup authorization
485
662
  MuxRuby.configure do |config|
@@ -490,25 +667,43 @@ end
490
667
 
491
668
  api_instance = MuxRuby::AssetsApi.new
492
669
  opts = {
493
- limit: 25, # Integer | Number of items to include in the response
494
- page: 1 # Integer | Offset by this many pages, of the size of `limit`
670
+ limit: 56, # Integer | Number of items to include in the response
671
+ page: 56 # Integer | Offset by this many pages, of the size of `limit`
495
672
  }
496
673
 
497
674
  begin
498
- #List assets
675
+ # List assets
499
676
  result = api_instance.list_assets(opts)
500
677
  p result
501
678
  rescue MuxRuby::ApiError => e
502
- puts "Exception when calling AssetsApi->list_assets: #{e}"
679
+ puts "Error when calling AssetsApi->list_assets: #{e}"
680
+ end
681
+ ```
682
+
683
+ #### Using the list_assets_with_http_info variant
684
+
685
+ This returns an Array which contains the response data, status code and headers.
686
+
687
+ > <Array(<ListAssetsResponse>, Integer, Hash)> list_assets_with_http_info(opts)
688
+
689
+ ```ruby
690
+ begin
691
+ # List assets
692
+ data, status_code, headers = api_instance.list_assets_with_http_info(opts)
693
+ p status_code # => 2xx
694
+ p headers # => { ... }
695
+ p data # => <ListAssetsResponse>
696
+ rescue MuxRuby::ApiError => e
697
+ puts "Error when calling AssetsApi->list_assets_with_http_info: #{e}"
503
698
  end
504
699
  ```
505
700
 
506
701
  ### Parameters
507
702
 
508
- Name | Type | Description | Notes
509
- ------------- | ------------- | ------------- | -------------
510
- **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
511
- **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
703
+ | Name | Type | Description | Notes |
704
+ | ---- | ---- | ----------- | ----- |
705
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
706
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
512
707
 
513
708
  ### Return type
514
709
 
@@ -520,21 +715,22 @@ Name | Type | Description | Notes
520
715
 
521
716
  ### HTTP request headers
522
717
 
523
- - **Content-Type**: Not defined
524
- - **Accept**: application/json
718
+ - **Content-Type**: Not defined
719
+ - **Accept**: application/json
525
720
 
526
721
 
722
+ ## update_asset_master_access
527
723
 
528
- # **update_asset_master_access**
529
- > AssetResponse update_asset_master_access(asset_id, update_asset_master_access_request)
724
+ > <AssetResponse> update_asset_master_access(asset_id, update_asset_master_access_request)
530
725
 
531
726
  Update master access
532
727
 
533
- Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
728
+ Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
729
+
730
+ ### Examples
534
731
 
535
- ### Example
536
732
  ```ruby
537
- # load the gem
733
+ require 'time'
538
734
  require 'mux_ruby'
539
735
  # setup authorization
540
736
  MuxRuby.configure do |config|
@@ -548,20 +744,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
548
744
  update_asset_master_access_request = MuxRuby::UpdateAssetMasterAccessRequest.new # UpdateAssetMasterAccessRequest |
549
745
 
550
746
  begin
551
- #Update master access
747
+ # Update master access
552
748
  result = api_instance.update_asset_master_access(asset_id, update_asset_master_access_request)
553
749
  p result
554
750
  rescue MuxRuby::ApiError => e
555
- puts "Exception when calling AssetsApi->update_asset_master_access: #{e}"
751
+ puts "Error when calling AssetsApi->update_asset_master_access: #{e}"
752
+ end
753
+ ```
754
+
755
+ #### Using the update_asset_master_access_with_http_info variant
756
+
757
+ This returns an Array which contains the response data, status code and headers.
758
+
759
+ > <Array(<AssetResponse>, Integer, Hash)> update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request)
760
+
761
+ ```ruby
762
+ begin
763
+ # Update master access
764
+ data, status_code, headers = api_instance.update_asset_master_access_with_http_info(asset_id, update_asset_master_access_request)
765
+ p status_code # => 2xx
766
+ p headers # => { ... }
767
+ p data # => <AssetResponse>
768
+ rescue MuxRuby::ApiError => e
769
+ puts "Error when calling AssetsApi->update_asset_master_access_with_http_info: #{e}"
556
770
  end
557
771
  ```
558
772
 
559
773
  ### Parameters
560
774
 
561
- Name | Type | Description | Notes
562
- ------------- | ------------- | ------------- | -------------
563
- **asset_id** | **String**| The asset ID. |
564
- **update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md)| |
775
+ | Name | Type | Description | Notes |
776
+ | ---- | ---- | ----------- | ----- |
777
+ | **asset_id** | **String** | The asset ID. | |
778
+ | **update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md) | | |
565
779
 
566
780
  ### Return type
567
781
 
@@ -573,21 +787,22 @@ Name | Type | Description | Notes
573
787
 
574
788
  ### HTTP request headers
575
789
 
576
- - **Content-Type**: application/json
577
- - **Accept**: application/json
790
+ - **Content-Type**: application/json
791
+ - **Accept**: application/json
578
792
 
579
793
 
794
+ ## update_asset_mp4_support
580
795
 
581
- # **update_asset_mp4_support**
582
- > AssetResponse update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
796
+ > <AssetResponse> update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
583
797
 
584
798
  Update MP4 support
585
799
 
586
- Allows you add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
800
+ Allows you to add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
801
+
802
+ ### Examples
587
803
 
588
- ### Example
589
804
  ```ruby
590
- # load the gem
805
+ require 'time'
591
806
  require 'mux_ruby'
592
807
  # setup authorization
593
808
  MuxRuby.configure do |config|
@@ -601,20 +816,38 @@ asset_id = 'asset_id_example' # String | The asset ID.
601
816
  update_asset_mp4_support_request = MuxRuby::UpdateAssetMP4SupportRequest.new # UpdateAssetMP4SupportRequest |
602
817
 
603
818
  begin
604
- #Update MP4 support
819
+ # Update MP4 support
605
820
  result = api_instance.update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
606
821
  p result
607
822
  rescue MuxRuby::ApiError => e
608
- puts "Exception when calling AssetsApi->update_asset_mp4_support: #{e}"
823
+ puts "Error when calling AssetsApi->update_asset_mp4_support: #{e}"
824
+ end
825
+ ```
826
+
827
+ #### Using the update_asset_mp4_support_with_http_info variant
828
+
829
+ This returns an Array which contains the response data, status code and headers.
830
+
831
+ > <Array(<AssetResponse>, Integer, Hash)> update_asset_mp4_support_with_http_info(asset_id, update_asset_mp4_support_request)
832
+
833
+ ```ruby
834
+ begin
835
+ # Update MP4 support
836
+ data, status_code, headers = api_instance.update_asset_mp4_support_with_http_info(asset_id, update_asset_mp4_support_request)
837
+ p status_code # => 2xx
838
+ p headers # => { ... }
839
+ p data # => <AssetResponse>
840
+ rescue MuxRuby::ApiError => e
841
+ puts "Error when calling AssetsApi->update_asset_mp4_support_with_http_info: #{e}"
609
842
  end
610
843
  ```
611
844
 
612
845
  ### Parameters
613
846
 
614
- Name | Type | Description | Notes
615
- ------------- | ------------- | ------------- | -------------
616
- **asset_id** | **String**| The asset ID. |
617
- **update_asset_mp4_support_request** | [**UpdateAssetMP4SupportRequest**](UpdateAssetMP4SupportRequest.md)| |
847
+ | Name | Type | Description | Notes |
848
+ | ---- | ---- | ----------- | ----- |
849
+ | **asset_id** | **String** | The asset ID. | |
850
+ | **update_asset_mp4_support_request** | [**UpdateAssetMP4SupportRequest**](UpdateAssetMP4SupportRequest.md) | | |
618
851
 
619
852
  ### Return type
620
853
 
@@ -626,8 +859,6 @@ Name | Type | Description | Notes
626
859
 
627
860
  ### HTTP request headers
628
861
 
629
- - **Content-Type**: application/json
630
- - **Accept**: application/json
631
-
632
-
862
+ - **Content-Type**: application/json
863
+ - **Accept**: application/json
633
864