mux_ruby 2.0.0.pre.rc.1 → 2.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +6 -6
  3. data/README.md +5 -4
  4. data/docs/Asset.md +4 -2
  5. data/docs/AssetsApi.md +10 -4
  6. data/docs/CreateLiveStreamRequest.md +4 -0
  7. data/docs/CreateTrackRequest.md +1 -1
  8. data/docs/DeliveryUsageApi.md +3 -3
  9. data/docs/ErrorsApi.md +1 -1
  10. data/docs/ExportDate.md +20 -0
  11. data/docs/ExportFile.md +22 -0
  12. data/docs/ExportsApi.md +69 -1
  13. data/docs/IncidentsApi.md +3 -3
  14. data/docs/ListVideoViewExportsResponse.md +22 -0
  15. data/docs/LiveStream.md +4 -0
  16. data/docs/MetricsApi.md +13 -13
  17. data/docs/PlaybackIDApi.md +1 -1
  18. data/docs/RealTimeApi.md +5 -5
  19. data/docs/RealTimeBreakdownValue.md +2 -2
  20. data/docs/RealTimeTimeseriesDatapoint.md +2 -2
  21. data/docs/URLSigningKeysApi.md +3 -3
  22. data/docs/VideoView.md +17 -1
  23. data/docs/VideoViewsApi.md +2 -2
  24. data/gen/generator-config.json +2 -1
  25. data/gen/templates/gemspec.mustache +1 -0
  26. data/lib/mux_ruby/api/assets_api.rb +16 -8
  27. data/lib/mux_ruby/api/delivery_usage_api.rb +6 -6
  28. data/lib/mux_ruby/api/dimensions_api.rb +2 -2
  29. data/lib/mux_ruby/api/direct_uploads_api.rb +2 -2
  30. data/lib/mux_ruby/api/errors_api.rb +4 -4
  31. data/lib/mux_ruby/api/exports_api.rb +61 -4
  32. data/lib/mux_ruby/api/filters_api.rb +2 -2
  33. data/lib/mux_ruby/api/incidents_api.rb +8 -8
  34. data/lib/mux_ruby/api/live_streams_api.rb +2 -2
  35. data/lib/mux_ruby/api/metrics_api.rb +28 -28
  36. data/lib/mux_ruby/api/playback_id_api.rb +4 -4
  37. data/lib/mux_ruby/api/real_time_api.rb +12 -12
  38. data/lib/mux_ruby/api/url_signing_keys_api.rb +8 -8
  39. data/lib/mux_ruby/api/video_views_api.rb +6 -6
  40. data/lib/mux_ruby/api_client.rb +2 -2
  41. data/lib/mux_ruby/api_error.rb +2 -2
  42. data/lib/mux_ruby/configuration.rb +2 -2
  43. data/lib/mux_ruby/models/abridged_video_view.rb +2 -2
  44. data/lib/mux_ruby/models/asset.rb +15 -5
  45. data/lib/mux_ruby/models/asset_errors.rb +2 -2
  46. data/lib/mux_ruby/models/asset_master.rb +2 -2
  47. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +2 -2
  48. data/lib/mux_ruby/models/asset_recording_times.rb +2 -2
  49. data/lib/mux_ruby/models/asset_response.rb +2 -2
  50. data/lib/mux_ruby/models/asset_static_renditions.rb +2 -2
  51. data/lib/mux_ruby/models/asset_static_renditions_files.rb +2 -2
  52. data/lib/mux_ruby/models/breakdown_value.rb +2 -2
  53. data/lib/mux_ruby/models/create_asset_request.rb +2 -2
  54. data/lib/mux_ruby/models/create_live_stream_request.rb +23 -3
  55. data/lib/mux_ruby/models/create_playback_id_request.rb +2 -2
  56. data/lib/mux_ruby/models/create_playback_id_response.rb +2 -2
  57. data/lib/mux_ruby/models/create_simulcast_target_request.rb +2 -2
  58. data/lib/mux_ruby/models/create_track_request.rb +3 -3
  59. data/lib/mux_ruby/models/create_track_response.rb +2 -2
  60. data/lib/mux_ruby/models/create_upload_request.rb +2 -2
  61. data/lib/mux_ruby/models/delivery_report.rb +2 -2
  62. data/lib/mux_ruby/models/dimension_value.rb +2 -2
  63. data/lib/mux_ruby/models/disable_live_stream_response.rb +2 -2
  64. data/lib/mux_ruby/models/enable_live_stream_response.rb +2 -2
  65. data/lib/mux_ruby/models/error.rb +2 -2
  66. data/lib/mux_ruby/models/export_date.rb +229 -0
  67. data/lib/mux_ruby/models/export_file.rb +236 -0
  68. data/lib/mux_ruby/models/filter_value.rb +2 -2
  69. data/lib/mux_ruby/models/get_asset_input_info_response.rb +2 -2
  70. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response.rb +2 -2
  71. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data.rb +2 -2
  72. data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb +2 -2
  73. data/lib/mux_ruby/models/get_asset_playback_id_response.rb +2 -2
  74. data/lib/mux_ruby/models/get_metric_timeseries_data_response.rb +2 -2
  75. data/lib/mux_ruby/models/get_overall_values_response.rb +2 -2
  76. data/lib/mux_ruby/models/get_real_time_breakdown_response.rb +2 -2
  77. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response.rb +2 -2
  78. data/lib/mux_ruby/models/get_real_time_histogram_timeseries_response_meta.rb +2 -2
  79. data/lib/mux_ruby/models/get_real_time_timeseries_response.rb +2 -2
  80. data/lib/mux_ruby/models/incident.rb +2 -2
  81. data/lib/mux_ruby/models/incident_breakdown.rb +2 -2
  82. data/lib/mux_ruby/models/incident_notification.rb +2 -2
  83. data/lib/mux_ruby/models/incident_notification_rule.rb +2 -2
  84. data/lib/mux_ruby/models/incident_response.rb +2 -2
  85. data/lib/mux_ruby/models/input_file.rb +2 -2
  86. data/lib/mux_ruby/models/input_info.rb +2 -2
  87. data/lib/mux_ruby/models/input_settings.rb +2 -2
  88. data/lib/mux_ruby/models/input_settings_overlay_settings.rb +2 -2
  89. data/lib/mux_ruby/models/input_track.rb +2 -2
  90. data/lib/mux_ruby/models/insight.rb +2 -2
  91. data/lib/mux_ruby/models/list_all_metric_values_response.rb +2 -2
  92. data/lib/mux_ruby/models/list_assets_response.rb +2 -2
  93. data/lib/mux_ruby/models/list_breakdown_values_response.rb +2 -2
  94. data/lib/mux_ruby/models/list_delivery_usage_response.rb +2 -2
  95. data/lib/mux_ruby/models/list_dimension_values_response.rb +2 -2
  96. data/lib/mux_ruby/models/list_dimensions_response.rb +2 -2
  97. data/lib/mux_ruby/models/list_errors_response.rb +2 -2
  98. data/lib/mux_ruby/models/list_exports_response.rb +2 -2
  99. data/lib/mux_ruby/models/list_filter_values_response.rb +2 -2
  100. data/lib/mux_ruby/models/list_filters_response.rb +2 -2
  101. data/lib/mux_ruby/models/list_filters_response_data.rb +2 -2
  102. data/lib/mux_ruby/models/list_incidents_response.rb +2 -2
  103. data/lib/mux_ruby/models/list_insights_response.rb +2 -2
  104. data/lib/mux_ruby/models/list_live_streams_response.rb +2 -2
  105. data/lib/mux_ruby/models/list_real_time_dimensions_response.rb +2 -2
  106. data/lib/mux_ruby/models/list_real_time_dimensions_response_data.rb +2 -2
  107. data/lib/mux_ruby/models/list_real_time_metrics_response.rb +2 -2
  108. data/lib/mux_ruby/models/list_related_incidents_response.rb +2 -2
  109. data/lib/mux_ruby/models/list_signing_keys_response.rb +2 -2
  110. data/lib/mux_ruby/models/list_uploads_response.rb +2 -2
  111. data/lib/mux_ruby/models/list_video_view_exports_response.rb +240 -0
  112. data/lib/mux_ruby/models/list_video_views_response.rb +2 -2
  113. data/lib/mux_ruby/models/live_stream.rb +23 -3
  114. data/lib/mux_ruby/models/live_stream_response.rb +2 -2
  115. data/lib/mux_ruby/models/metric.rb +2 -2
  116. data/lib/mux_ruby/models/notification_rule.rb +2 -2
  117. data/lib/mux_ruby/models/overall_values.rb +2 -2
  118. data/lib/mux_ruby/models/playback_id.rb +2 -2
  119. data/lib/mux_ruby/models/playback_policy.rb +2 -2
  120. data/lib/mux_ruby/models/real_time_breakdown_value.rb +9 -9
  121. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket.rb +2 -2
  122. data/lib/mux_ruby/models/real_time_histogram_timeseries_bucket_values.rb +2 -2
  123. data/lib/mux_ruby/models/real_time_histogram_timeseries_datapoint.rb +2 -2
  124. data/lib/mux_ruby/models/real_time_timeseries_datapoint.rb +9 -9
  125. data/lib/mux_ruby/models/score.rb +2 -2
  126. data/lib/mux_ruby/models/signal_live_stream_complete_response.rb +2 -2
  127. data/lib/mux_ruby/models/signing_key.rb +2 -2
  128. data/lib/mux_ruby/models/signing_key_response.rb +2 -2
  129. data/lib/mux_ruby/models/simulcast_target.rb +2 -2
  130. data/lib/mux_ruby/models/simulcast_target_response.rb +2 -2
  131. data/lib/mux_ruby/models/track.rb +2 -2
  132. data/lib/mux_ruby/models/update_asset_master_access_request.rb +2 -2
  133. data/lib/mux_ruby/models/update_asset_mp4_support_request.rb +2 -2
  134. data/lib/mux_ruby/models/upload.rb +2 -2
  135. data/lib/mux_ruby/models/upload_error.rb +2 -2
  136. data/lib/mux_ruby/models/upload_response.rb +2 -2
  137. data/lib/mux_ruby/models/video_view.rb +78 -6
  138. data/lib/mux_ruby/models/video_view_event.rb +2 -2
  139. data/lib/mux_ruby/models/video_view_response.rb +2 -2
  140. data/lib/mux_ruby/version.rb +3 -3
  141. data/lib/mux_ruby.rb +5 -2
  142. data/mux_ruby.gemspec +3 -2
  143. data/spec/api_client_spec.rb +2 -2
  144. data/spec/configuration_spec.rb +2 -2
  145. data/spec/models/export_date_spec.rb +40 -0
  146. data/spec/models/export_file_spec.rb +46 -0
  147. data/spec/models/list_video_view_exports_response_spec.rb +46 -0
  148. data/spec/spec_helper.rb +2 -2
  149. metadata +109 -96
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c28d49a2c666ce9ae287c24568e3ac96f76ce88fe2379da51685342f7ecdf0af
4
- data.tar.gz: c41db82bdd105f37ff892b4225dbdefe9a8582e244b27598c3ce81d849cdf67d
3
+ metadata.gz: 44c937ce2f7785420b50a766695222406348f91f883995215717db027a7b7c44
4
+ data.tar.gz: fba6ffdabd6fa52f8e189d46261fc54052a80044dc9856c7d9a5927e1b3d8ad6
5
5
  SHA512:
6
- metadata.gz: cfd040f2a3ca7024191c8d915ae9f715d51ae4667e0b19d61f76208d06d093e6d9a97c5f488f1a0a0869a965d2c301edd97b12a92bef30b50e7c63c747ed6986
7
- data.tar.gz: 28f825f2fb898231ca945877dd2d2fee242e6f8ada10fa36d8b16b48222cf493ce0a712dcedabb0c520d6a817176151043394e50770fd61814c2464167f95a5e
6
+ metadata.gz: ac85c2e8118ca383192f7fd4e416bacb06b3715fc863cd0d29aa5e8d8c60c0801ced666a051766616f7ad5755cb3e58e278ed9c139c254d91589b8c78460cb58
7
+ data.tar.gz: 8dd842dd4222c06018d9daa2d6b9b5a2698346cd38f5192e7ac942c69d6e461e37e17fb2b9c3d9e04ec5c1055e37765ca28af03d10100583d48e10e659cf3490
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (2.0.0.pre.rc.1)
4
+ mux_ruby (2.1.1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -13,11 +13,11 @@ GEM
13
13
  diff-lcs (1.3)
14
14
  ethon (0.14.0)
15
15
  ffi (>= 1.15.0)
16
- ffi (1.15.1)
16
+ ffi (1.15.4)
17
17
  jaro_winkler (1.5.4)
18
18
  method_source (1.0.0)
19
19
  parallel (1.20.1)
20
- parser (3.0.1.1)
20
+ parser (3.0.2.0)
21
21
  ast (~> 2.4.1)
22
22
  pry (0.13.1)
23
23
  coderay (~> 1.1)
@@ -25,9 +25,9 @@ GEM
25
25
  pry-byebug (3.9.0)
26
26
  byebug (~> 11.0)
27
27
  pry (~> 0.13.0)
28
- psych (4.0.0)
28
+ psych (4.0.1)
29
29
  rainbow (3.0.0)
30
- rake (13.0.3)
30
+ rake (13.0.6)
31
31
  rspec (3.9.0)
32
32
  rspec-core (~> 3.9.0)
33
33
  rspec-expectations (~> 3.9.0)
@@ -67,4 +67,4 @@ DEPENDENCIES
67
67
  solid_assert
68
68
 
69
69
  BUNDLED WITH
70
- 2.2.18
70
+ 2.2.27
data/README.md CHANGED
@@ -17,8 +17,9 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
17
17
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
18
18
 
19
19
  - API version: v1
20
- - Package version: 2.0.0-rc.1
20
+ - Package version: 2.1.1
21
21
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
22
+ For more information, please visit [https://docs.mux.com](https://docs.mux.com)
22
23
 
23
24
  ## Installation
24
25
 
@@ -33,16 +34,16 @@ gem build mux_ruby.gemspec
33
34
  Then either install the gem locally:
34
35
 
35
36
  ```shell
36
- gem install ./mux_ruby-2.0.0-rc.1.gem
37
+ gem install ./mux_ruby-2.1.1.gem
37
38
  ```
38
39
 
39
- (for development, run `gem install --dev ./mux_ruby-2.0.0-rc.1.gem` to install the development dependencies)
40
+ (for development, run `gem install --dev ./mux_ruby-2.1.1.gem` to install the development dependencies)
40
41
 
41
42
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
42
43
 
43
44
  Finally add this to the Gemfile:
44
45
 
45
- gem 'mux_ruby', '~> 2.0.0-rc.1'
46
+ gem 'mux_ruby', '~> 2.1.1'
46
47
 
47
48
  ### Install from Git
48
49
 
data/docs/Asset.md CHANGED
@@ -7,14 +7,15 @@
7
7
  | **id** | **String** | Unique identifier for the Asset. Max 255 characters. | [optional] |
8
8
  | **created_at** | **String** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
9
9
  | **status** | **String** | The status of the asset. | [optional] |
10
- | **duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional] |
10
+ | **duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 12 hours). | [optional] |
11
11
  | **max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] |
12
- | **max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional] |
12
+ | **max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. | [optional] |
13
13
  | **aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] |
14
14
  | **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
15
15
  | **tracks** | [**Array<Track>**](Track.md) | The individual media tracks that make up an asset. | [optional] |
16
16
  | **errors** | [**AssetErrors**](AssetErrors.md) | | [optional] |
17
17
  | **per_title_encode** | **Boolean** | | [optional] |
18
+ | **upload_id** | **String** | Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. | [optional] |
18
19
  | **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] |
19
20
  | **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
20
21
  | **live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] |
@@ -45,6 +46,7 @@ instance = MuxRuby::Asset.new(
45
46
  tracks: null,
46
47
  errors: null,
47
48
  per_title_encode: null,
49
+ upload_id: null,
48
50
  is_live: null,
49
51
  passthrough: null,
50
52
  live_stream_id: null,
data/docs/AssetsApi.md CHANGED
@@ -24,7 +24,7 @@ All URIs are relative to *https://api.mux.com*
24
24
 
25
25
  Create an asset
26
26
 
27
- Create a new Mux Video asset.
27
+ Create a new Mux Video asset.
28
28
 
29
29
  ### Examples
30
30
 
@@ -234,7 +234,7 @@ end
234
234
 
235
235
  Delete an asset
236
236
 
237
- Deletes a video asset and all its data
237
+ Deletes a video asset and all its data.
238
238
 
239
239
  ### Examples
240
240
 
@@ -372,6 +372,8 @@ nil (empty response body)
372
372
 
373
373
  Delete an asset track
374
374
 
375
+ Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
376
+
375
377
  ### Examples
376
378
 
377
379
  ```ruby
@@ -651,7 +653,7 @@ end
651
653
 
652
654
  List assets
653
655
 
654
- List all Mux assets.
656
+ List all Mux assets.
655
657
 
656
658
  ### Examples
657
659
 
@@ -668,7 +670,9 @@ end
668
670
  api_instance = MuxRuby::AssetsApi.new
669
671
  opts = {
670
672
  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`
673
+ page: 56, # Integer | Offset by this many pages, of the size of `limit`
674
+ live_stream_id: 'live_stream_id_example', # String | Filter response to return all the assets for this live stream only
675
+ upload_id: 'upload_id_example' # String | Filter response to return an asset created from this direct upload only
672
676
  }
673
677
 
674
678
  begin
@@ -704,6 +708,8 @@ end
704
708
  | ---- | ---- | ----------- | ----- |
705
709
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
706
710
  | **page** | **Integer** | Offset by this many pages, of the size of `limit` | [optional][default to 1] |
711
+ | **live_stream_id** | **String** | Filter response to return all the assets for this live stream only | [optional] |
712
+ | **upload_id** | **String** | Filter response to return an asset created from this direct upload only | [optional] |
707
713
 
708
714
  ### Return type
709
715
 
data/docs/CreateLiveStreamRequest.md CHANGED
@@ -8,7 +8,9 @@
8
8
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
9
9
  | **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] |
10
10
  | **passthrough** | **String** | | [optional] |
11
+ | **audio_only** | **Boolean** | Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted. | [optional] |
11
12
  | **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] |
13
+ | **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
12
14
  | **test** | **Boolean** | Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
13
15
  | **simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) | | [optional] |
14
16
 
@@ -22,7 +24,9 @@ instance = MuxRuby::CreateLiveStreamRequest.new(
22
24
  new_asset_settings: null,
23
25
  reconnect_window: null,
24
26
  passthrough: null,
27
+ audio_only: null,
25
28
  reduced_latency: null,
29
+ low_latency: null,
26
30
  test: null,
27
31
  simulcast_targets: null
28
32
  )
data/docs/CreateTrackRequest.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **type** | **String** | | |
9
9
  | **text_type** | **String** | | |
10
10
  | **language_code** | **String** | The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. | |
11
- | **name** | **String** | The name of the track containing a human-readable description. This value must be unqiue across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] |
11
+ | **name** | **String** | The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to \"English\" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value. | [optional] |
12
12
  | **closed_captions** | **Boolean** | Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). | [optional] |
13
13
  | **passthrough** | **String** | Arbitrary metadata set for the track either when creating the asset or track. | [optional] |
14
14
 
data/docs/DeliveryUsageApi.md CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.mux.com*
13
13
 
14
14
  List Usage
15
15
 
16
- Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
16
+ Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.
17
17
 
18
18
  ### Examples
19
19
 
@@ -32,7 +32,7 @@ opts = {
32
32
  page: 56, # Integer | Offset by this many pages, of the size of `limit`
33
33
  limit: 56, # Integer | Number of items to include in the response
34
34
  asset_id: 'asset_id_example', # String | Filter response to return delivery usage for this asset only.
35
- timeframe: ['inner_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
35
+ timeframe: ['inner_example'] # Array<String> | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.
36
36
  }
37
37
 
38
38
  begin
@@ -69,7 +69,7 @@ end
69
69
  | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
70
70
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 100] |
71
71
  | **asset_id** | **String** | Filter response to return delivery usage for this asset only. | [optional] |
72
- | **timeframe** | [**Array&lt;String&gt;**](String.md) | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional] |
72
+ | **timeframe** | [**Array&lt;String&gt;**](String.md) | Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made. | [optional] |
73
73
 
74
74
  ### Return type
75
75
 
data/docs/ErrorsApi.md CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.mux.com*
13
13
 
14
14
  List Errors
15
15
 
16
- Returns a list of errors
16
+ Returns a list of errors.
17
17
 
18
18
  ### Examples
19
19
 
data/docs/ExportDate.md ADDED
@@ -0,0 +1,20 @@
1
+ # MuxRuby::ExportDate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **export_date** | **Date** | | [optional] |
8
+ | **files** | [**Array&lt;ExportFile&gt;**](ExportFile.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mux_ruby'
14
+
15
+ instance = MuxRuby::ExportDate.new(
16
+ export_date: null,
17
+ files: null
18
+ )
19
+ ```
20
+
data/docs/ExportFile.md ADDED
@@ -0,0 +1,22 @@
1
+ # MuxRuby::ExportFile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **Integer** | | [optional] |
8
+ | **type** | **String** | | [optional] |
9
+ | **path** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::ExportFile.new(
17
+ version: null,
18
+ type: null,
19
+ path: null
20
+ )
21
+ ```
22
+
data/docs/ExportsApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.mux.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**list_exports**](ExportsApi.md#list_exports) | **GET** /data/v1/exports | List property video view export links |
8
+ | [**list_exports_views**](ExportsApi.md#list_exports_views) | **GET** /data/v1/exports/views | List available property view exports |
8
9
 
9
10
 
10
11
  ## list_exports
@@ -13,7 +14,7 @@ All URIs are relative to *https://api.mux.com*
13
14
 
14
15
  List property video view export links
15
16
 
16
- Lists the available video view exports along with URLs to retrieve them
17
+ Deprecated: The API has been replaced by the list-exports-views API call. Lists the available video view exports along with URLs to retrieve them.
17
18
 
18
19
  ### Examples
19
20
 
@@ -73,3 +74,70 @@ This endpoint does not need any parameter.
73
74
  - **Content-Type**: Not defined
74
75
  - **Accept**: application/json
75
76
 
77
+
78
+ ## list_exports_views
79
+
80
+ > <ListVideoViewExportsResponse> list_exports_views
81
+
82
+ List available property view exports
83
+
84
+ Lists the available video view exports along with URLs to retrieve them.
85
+
86
+ ### Examples
87
+
88
+ ```ruby
89
+ require 'time'
90
+ require 'mux_ruby'
91
+ # setup authorization
92
+ MuxRuby.configure do |config|
93
+ # Configure HTTP basic authorization: accessToken
94
+ config.username = 'YOUR USERNAME'
95
+ config.password = 'YOUR PASSWORD'
96
+ end
97
+
98
+ api_instance = MuxRuby::ExportsApi.new
99
+
100
+ begin
101
+ # List available property view exports
102
+ result = api_instance.list_exports_views
103
+ p result
104
+ rescue MuxRuby::ApiError => e
105
+ puts "Error when calling ExportsApi->list_exports_views: #{e}"
106
+ end
107
+ ```
108
+
109
+ #### Using the list_exports_views_with_http_info variant
110
+
111
+ This returns an Array which contains the response data, status code and headers.
112
+
113
+ > <Array(<ListVideoViewExportsResponse>, Integer, Hash)> list_exports_views_with_http_info
114
+
115
+ ```ruby
116
+ begin
117
+ # List available property view exports
118
+ data, status_code, headers = api_instance.list_exports_views_with_http_info
119
+ p status_code # => 2xx
120
+ p headers # => { ... }
121
+ p data # => <ListVideoViewExportsResponse>
122
+ rescue MuxRuby::ApiError => e
123
+ puts "Error when calling ExportsApi->list_exports_views_with_http_info: #{e}"
124
+ end
125
+ ```
126
+
127
+ ### Parameters
128
+
129
+ This endpoint does not need any parameter.
130
+
131
+ ### Return type
132
+
133
+ [**ListVideoViewExportsResponse**](ListVideoViewExportsResponse.md)
134
+
135
+ ### Authorization
136
+
137
+ [accessToken](../README.md#accessToken)
138
+
139
+ ### HTTP request headers
140
+
141
+ - **Content-Type**: Not defined
142
+ - **Accept**: application/json
143
+
data/docs/IncidentsApi.md CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.mux.com*
15
15
 
16
16
  Get an Incident
17
17
 
18
- Returns the details of an incident
18
+ Returns the details of an incident.
19
19
 
20
20
  ### Examples
21
21
 
@@ -85,7 +85,7 @@ end
85
85
 
86
86
  List Incidents
87
87
 
88
- Returns a list of incidents
88
+ Returns a list of incidents.
89
89
 
90
90
  ### Examples
91
91
 
@@ -167,7 +167,7 @@ end
167
167
 
168
168
  List Related Incidents
169
169
 
170
- Returns all the incidents that seem related to a specific incident
170
+ Returns all the incidents that seem related to a specific incident.
171
171
 
172
172
  ### Examples
173
173
 
data/docs/ListVideoViewExportsResponse.md ADDED
@@ -0,0 +1,22 @@
1
+ # MuxRuby::ListVideoViewExportsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;ExportDate&gt;**](ExportDate.md) | | [optional] |
8
+ | **total_row_count** | **Integer** | | [optional] |
9
+ | **timeframe** | **Array&lt;Integer&gt;** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::ListVideoViewExportsResponse.new(
17
+ data: null,
18
+ total_row_count: null,
19
+ timeframe: null
20
+ )
21
+ ```
22
+
data/docs/LiveStream.md CHANGED
@@ -13,8 +13,10 @@
13
13
  | **playback_ids** | [**Array&lt;PlaybackID&gt;**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
14
14
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
15
15
  | **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
16
+ | **audio_only** | **Boolean** | The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted. | [optional] |
16
17
  | **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. **Min**: 0.1s. **Max**: 300s (5 minutes). | [optional][default to 60] |
17
18
  | **reduced_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. **Note**: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](https://docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs. | [optional] |
19
+ | **low_latency** | **Boolean** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds. | [optional] |
18
20
  | **simulcast_targets** | [**Array&lt;SimulcastTarget&gt;**](SimulcastTarget.md) | Each Simulcast Target contains configuration details to broadcast (or \&quot;restream\&quot;) a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](https://docs.mux.com/guides/video/stream-live-to-3rd-party-platforms). | [optional] |
19
21
  | **test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional] |
20
22
 
@@ -33,8 +35,10 @@ instance = MuxRuby::LiveStream.new(
33
35
  playback_ids: null,
34
36
  new_asset_settings: null,
35
37
  passthrough: null,
38
+ audio_only: null,
36
39
  reconnect_window: null,
37
40
  reduced_latency: null,
41
+ low_latency: null,
38
42
  simulcast_targets: null,
39
43
  test: null
40
44
  )
data/docs/MetricsApi.md CHANGED
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.mux.com*
17
17
 
18
18
  Get metric timeseries data
19
19
 
20
- Returns timeseries data for a specific metric
20
+ Returns timeseries data for a specific metric.
21
21
 
22
22
  ### Examples
23
23
 
@@ -36,7 +36,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
36
36
  opts = {
37
37
  timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
38
38
  filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
39
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
39
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
40
40
  order_direction: 'asc', # String | Sort order.
41
41
  group_by: 'hour' # String | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.
42
42
  }
@@ -75,7 +75,7 @@ end
75
75
  | **metric_id** | **String** | ID of the Metric | |
76
76
  | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
77
77
  | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
78
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional] |
78
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
79
79
  | **order_direction** | **String** | Sort order. | [optional] |
80
80
  | **group_by** | **String** | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional] |
81
81
 
@@ -99,7 +99,7 @@ end
99
99
 
100
100
  Get Overall values
101
101
 
102
- Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
102
+ Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
103
103
 
104
104
  ### Examples
105
105
 
@@ -118,7 +118,7 @@ metric_id = 'aggregate_startup_time' # String | ID of the Metric
118
118
  opts = {
119
119
  timeframe: ['inner_example'], # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
120
120
  filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
121
- measurement: '95th' # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
121
+ measurement: '95th' # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
122
122
  }
123
123
 
124
124
  begin
@@ -155,7 +155,7 @@ end
155
155
  | **metric_id** | **String** | ID of the Metric | |
156
156
  | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
157
157
  | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
158
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional] |
158
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
159
159
 
160
160
  ### Return type
161
161
 
@@ -177,7 +177,7 @@ end
177
177
 
178
178
  List all metric values
179
179
 
180
- List all of the values across every breakdown for a specific metric
180
+ List all of the values across every breakdown for a specific metric.
181
181
 
182
182
  ### Examples
183
183
 
@@ -255,7 +255,7 @@ end
255
255
 
256
256
  List breakdown values
257
257
 
258
- List the breakdown values for a specific metric
258
+ List the breakdown values for a specific metric.
259
259
 
260
260
  ### Examples
261
261
 
@@ -273,7 +273,7 @@ api_instance = MuxRuby::MetricsApi.new
273
273
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
274
274
  opts = {
275
275
  group_by: 'asn', # String | Breakdown value to group the results by
276
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
276
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
277
277
  filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint.
278
278
  limit: 56, # Integer | Number of items to include in the response
279
279
  page: 56, # Integer | Offset by this many pages, of the size of `limit`
@@ -315,7 +315,7 @@ end
315
315
  | ---- | ---- | ----------- | ----- |
316
316
  | **metric_id** | **String** | ID of the Metric | |
317
317
  | **group_by** | **String** | Breakdown value to group the results by | [optional] |
318
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional] |
318
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
319
319
  | **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] |
320
320
  | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
321
321
  | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
@@ -343,7 +343,7 @@ end
343
343
 
344
344
  List Insights
345
345
 
346
- Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
346
+ Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
347
347
 
348
348
  ### Examples
349
349
 
@@ -360,7 +360,7 @@ end
360
360
  api_instance = MuxRuby::MetricsApi.new
361
361
  metric_id = 'aggregate_startup_time' # String | ID of the Metric
362
362
  opts = {
363
- measurement: '95th', # String | Measurement for the provided metric. If omitted, the deafult for the metric will be used.
363
+ measurement: '95th', # String | Measurement for the provided metric. If omitted, the default for the metric will be used.
364
364
  order_direction: 'asc', # String | Sort order.
365
365
  timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600 * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.
366
366
  }
@@ -397,7 +397,7 @@ end
397
397
  | Name | Type | Description | Notes |
398
398
  | ---- | ---- | ----------- | ----- |
399
399
  | **metric_id** | **String** | ID of the Metric | |
400
- | **measurement** | **String** | Measurement for the provided metric. If omitted, the deafult for the metric will be used. | [optional] |
400
+ | **measurement** | **String** | Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] |
401
401
  | **order_direction** | **String** | Sort order. | [optional] |
402
402
  | **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600 * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days. | [optional] |
403
403