mux_ruby 3.20.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +4 -4
  4. data/docs/Asset.md +4 -2
  5. data/docs/AssetMetadata.md +22 -0
  6. data/docs/AssetStaticRenditions.md +2 -2
  7. data/docs/AssetsApi.md +146 -1
  8. data/docs/CreateAssetRequest.md +14 -6
  9. data/docs/CreateLiveStreamRequest.md +4 -2
  10. data/docs/CreateStaticRenditionRequest.md +20 -0
  11. data/docs/CreateStaticRenditionResponse.md +18 -0
  12. data/docs/InputSettings.md +1 -1
  13. data/docs/LiveStreamsApi.md +143 -0
  14. data/docs/PlaybackRestrictionsApi.md +1 -1
  15. data/docs/StaticRendition.md +40 -0
  16. data/docs/UpdateAssetRequest.md +4 -2
  17. data/docs/UpdateLiveStreamNewAssetSettings.md +6 -2
  18. data/docs/UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.md +18 -0
  19. data/docs/UpdateReferrerDomainRestrictionRequest.md +10 -37
  20. data/docs/Upload.md +1 -1
  21. data/docs/VideoView.md +35 -1
  22. data/examples/video/exercise-assets.rb +1 -1
  23. data/gen/generator-config.json +1 -1
  24. data/lib/mux_ruby/api/assets_api.rb +140 -2
  25. data/lib/mux_ruby/api/live_streams_api.rb +132 -0
  26. data/lib/mux_ruby/api/metrics_api.rb +2 -2
  27. data/lib/mux_ruby/models/asset.rb +14 -5
  28. data/lib/mux_ruby/models/{space_response.rb → asset_metadata.rb} +74 -13
  29. data/lib/mux_ruby/models/asset_static_renditions.rb +2 -2
  30. data/lib/mux_ruby/models/create_asset_request.rb +54 -9
  31. data/lib/mux_ruby/models/create_live_stream_request.rb +15 -2
  32. data/lib/mux_ruby/models/{create_broadcast_request.rb → create_static_rendition_request.rb} +49 -53
  33. data/lib/mux_ruby/models/{start_space_broadcast_response.rb → create_static_rendition_response.rb} +4 -4
  34. data/lib/mux_ruby/models/input_settings.rb +1 -1
  35. data/lib/mux_ruby/models/{asset_static_renditions_files.rb → static_rendition.rb} +118 -9
  36. data/lib/mux_ruby/models/update_asset_request.rb +14 -5
  37. data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb +37 -6
  38. data/lib/mux_ruby/models/{list_spaces_response.rb → update_live_stream_new_asset_settings_static_renditions_request.rb} +11 -16
  39. data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +203 -73
  40. data/lib/mux_ruby/models/upload.rb +1 -1
  41. data/lib/mux_ruby/models/video_view.rb +171 -4
  42. data/lib/mux_ruby/version.rb +1 -1
  43. data/lib/mux_ruby.rb +5 -16
  44. data/spec/models/asset_metadata_spec.rb +46 -0
  45. data/spec/models/create_static_rendition_request_spec.rb +44 -0
  46. data/spec/models/create_static_rendition_response_spec.rb +34 -0
  47. data/spec/models/static_rendition_spec.rb +124 -0
  48. data/spec/models/update_live_stream_new_asset_settings_static_renditions_request_spec.rb +34 -0
  49. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  50. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +8 -8
  51. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
  52. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
  53. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +19 -19
  54. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +7 -7
  55. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/jaro_winkler/jaro_winkler_ext.so +0 -0
  56. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
  57. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +5 -5
  58. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
  59. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
  60. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
  61. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
  62. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
  63. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  64. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
  65. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
  66. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler/Makefile +3 -3
  67. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  68. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +3 -3
  69. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
  70. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +3 -3
  71. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
  72. metadata +184 -199
  73. data/docs/AssetStaticRenditionsFiles.md +0 -28
  74. data/docs/Broadcast.md +0 -30
  75. data/docs/BroadcastLayout.md +0 -15
  76. data/docs/BroadcastResolution.md +0 -15
  77. data/docs/BroadcastResponse.md +0 -18
  78. data/docs/BroadcastStatus.md +0 -15
  79. data/docs/CreateBroadcastRequest.md +0 -26
  80. data/docs/CreateSpaceRequest.md +0 -22
  81. data/docs/ListSpacesResponse.md +0 -18
  82. data/docs/Space.md +0 -30
  83. data/docs/SpaceResponse.md +0 -18
  84. data/docs/SpaceStatus.md +0 -15
  85. data/docs/SpaceType.md +0 -15
  86. data/docs/SpacesApi.md +0 -658
  87. data/docs/StartSpaceBroadcastResponse.md +0 -18
  88. data/docs/StopSpaceBroadcastResponse.md +0 -18
  89. data/lib/mux_ruby/api/spaces_api.rb +0 -619
  90. data/lib/mux_ruby/models/broadcast.rb +0 -305
  91. data/lib/mux_ruby/models/broadcast_layout.rb +0 -38
  92. data/lib/mux_ruby/models/broadcast_resolution.rb +0 -41
  93. data/lib/mux_ruby/models/broadcast_response.rb +0 -223
  94. data/lib/mux_ruby/models/broadcast_status.rb +0 -37
  95. data/lib/mux_ruby/models/create_space_request.rb +0 -242
  96. data/lib/mux_ruby/models/space.rb +0 -301
  97. data/lib/mux_ruby/models/space_status.rb +0 -37
  98. data/lib/mux_ruby/models/space_type.rb +0 -36
  99. data/lib/mux_ruby/models/stop_space_broadcast_response.rb +0 -218
@@ -4,7 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **passthrough** | **String** | Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this value, the field should be included with an empty string value. | [optional] |
7
+ | **passthrough** | **String** | You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**. In order to clear this value, the field should be included with an empty string value. | [optional] |
8
+ | **meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional] |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'mux_ruby'
13
14
 
14
15
  instance = MuxRuby::UpdateAssetRequest.new(
15
- passthrough: null
16
+ passthrough: null,
17
+ meta: null
16
18
  )
17
19
  ```
18
20
 
@@ -4,8 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **mp4_support** | **String** | Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). | [optional] |
7
+ | **mp4_support** | **String** | Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#during-live-stream-creation) for the updated API. Specify what level of support for mp4 playback should be added to new assets generated from this live stream. * The `none` option disables MP4 support for new assets. MP4 files will not be produced for an asset generated from this live stream. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. * The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). | [optional] |
8
8
  | **master_access** | **String** | Add or remove access to the master version of the video. | [optional] |
9
+ | **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional] |
10
+ | **meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional] |
9
11
 
10
12
  ## Example
11
13
 
@@ -14,7 +16,9 @@ require 'mux_ruby'
14
16
 
15
17
  instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
16
18
  mp4_support: null,
17
- master_access: null
19
+ master_access: null,
20
+ video_quality: null,
21
+ meta: null
18
22
  )
19
23
  ```
20
24
 
@@ -0,0 +1,18 @@
1
+ # MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **static_renditions** | [**Array<CreateStaticRenditionRequest>**](CreateStaticRenditionRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest.new(
15
+ static_renditions: null
16
+ )
17
+ ```
18
+
@@ -1,47 +1,20 @@
1
1
  # MuxRuby::UpdateReferrerDomainRestrictionRequest
2
2
 
3
- ## Class instance methods
3
+ ## Properties
4
4
 
5
- ### `openapi_one_of`
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowed_domains** | **Array<String>** | List of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `[\"*\"]` A Single Wildcard `*` entry means allow video playback requests from any domain * `[\"*.example.com\", \"foo.com\"]` A list of up to 10 domains or valid dns-style wildcards | [optional] |
8
+ | **allow_no_referrer** | **Boolean** | A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests. | [optional][default to false] |
6
9
 
7
- Returns the list of classes defined in oneOf.
8
-
9
- #### Example
10
-
11
- ```ruby
12
- require 'mux_ruby'
13
-
14
- MuxRuby::UpdateReferrerDomainRestrictionRequest.openapi_one_of
15
- # =>
16
- # [
17
- # :'ReferrerDomainRestriction'
18
- # ]
19
- ```
20
-
21
- ### build
22
-
23
- Find the appropriate object from the `openapi_one_of` list and casts the data into it.
24
-
25
- #### Example
10
+ ## Example
26
11
 
27
12
  ```ruby
28
13
  require 'mux_ruby'
29
14
 
30
- MuxRuby::UpdateReferrerDomainRestrictionRequest.build(data)
31
- # => #<ReferrerDomainRestriction:0x00007fdd4aab02a0>
32
-
33
- MuxRuby::UpdateReferrerDomainRestrictionRequest.build(data_that_doesnt_match)
34
- # => nil
15
+ instance = MuxRuby::UpdateReferrerDomainRestrictionRequest.new(
16
+ allowed_domains: null,
17
+ allow_no_referrer: null
18
+ )
35
19
  ```
36
20
 
37
- #### Parameters
38
-
39
- | Name | Type | Description |
40
- | ---- | ---- | ----------- |
41
- | **data** | **Mixed** | data to be matched against the list of oneOf items |
42
-
43
- #### Return type
44
-
45
- - `ReferrerDomainRestriction`
46
- - `nil` (if no type matches)
47
-
data/docs/Upload.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | Unique identifier for the Direct Upload. | [optional] |
8
8
  | **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked &#x60;timed_out&#x60; | [optional][default to 3600] |
9
9
  | **status** | **String** | | [optional] |
10
- | **new_asset_settings** | [**Asset**](Asset.md) | | [optional] |
10
+ | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
11
11
  | **asset_id** | **String** | Only set once the upload is in the &#x60;asset_created&#x60; state. | [optional] |
12
12
  | **error** | [**UploadError**](UploadError.md) | | [optional] |
13
13
  | **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] |
data/docs/VideoView.md CHANGED
@@ -166,6 +166,23 @@
166
166
  | **view_content_startup_time** | **Integer** | | [optional] |
167
167
  | **ad_preroll_startup_time** | **Integer** | | [optional] |
168
168
  | **view_dropped** | **Boolean** | | [optional] |
169
+ | **client_application_name** | **String** | | [optional] |
170
+ | **client_application_version** | **String** | | [optional] |
171
+ | **video_affiliate** | **String** | | [optional] |
172
+ | **viewer_plan** | **String** | | [optional] |
173
+ | **viewer_plan_status** | **String** | | [optional] |
174
+ | **viewer_plan_category** | **String** | | [optional] |
175
+ | **view_drm_level** | **String** | | [optional] |
176
+ | **video_brand** | **String** | | [optional] |
177
+ | **used_pip** | **Boolean** | | [optional] |
178
+ | **time_shift_enabled** | **Boolean** | | [optional] |
179
+ | **used_captions** | **Boolean** | | [optional] |
180
+ | **video_codec** | **String** | | [optional] |
181
+ | **audio_codec** | **String** | | [optional] |
182
+ | **video_dynamic_range_type** | **String** | | [optional] |
183
+ | **view_cdn_edge_pop** | **String** | | [optional] |
184
+ | **view_cdn_origin** | **String** | | [optional] |
185
+ | **video_creator_id** | **String** | | [optional] |
169
186
 
170
187
  ## Example
171
188
 
@@ -334,7 +351,24 @@ instance = MuxRuby::VideoView.new(
334
351
  ad_playback_failure_error_type_id: null,
335
352
  view_content_startup_time: null,
336
353
  ad_preroll_startup_time: null,
337
- view_dropped: null
354
+ view_dropped: null,
355
+ client_application_name: null,
356
+ client_application_version: null,
357
+ video_affiliate: null,
358
+ viewer_plan: null,
359
+ viewer_plan_status: null,
360
+ viewer_plan_category: null,
361
+ view_drm_level: null,
362
+ video_brand: null,
363
+ used_pip: null,
364
+ time_shift_enabled: null,
365
+ used_captions: null,
366
+ video_codec: null,
367
+ audio_codec: null,
368
+ video_dynamic_range_type: null,
369
+ view_cdn_edge_pop: null,
370
+ view_cdn_origin: null,
371
+ video_creator_id: null
338
372
  )
339
373
  ```
340
374
 
@@ -119,7 +119,7 @@ assert asset_with_2_captions.data.tracks.length == 4 # Audio, Video, French that
119
119
  puts "create-asset-track OK ✅"
120
120
 
121
121
  # ========== delete-asset-track ==========
122
- Kernel.sleep(5)
122
+ Kernel.sleep(10)
123
123
  assets_api.delete_asset_track(create_response.data.id, subtitles_track.data.id)
124
124
  asset_with_1_captions = assets_api.get_asset(create_response.data.id)
125
125
  assert asset_with_1_captions.data.tracks.length == 3 # Audio, Video, French that we ingested with the asset
@@ -8,5 +8,5 @@
8
8
  "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
9
9
  "gemLicense": "MIT",
10
10
  "moduleName": "MuxRuby",
11
- "gemVersion": "3.20.0"
11
+ "gemVersion": "5.0.0"
12
12
  }
@@ -155,6 +155,77 @@ module MuxRuby
155
155
  return data, status_code, headers
156
156
  end
157
157
 
158
+ # Create a static rendition for an asset
159
+ # Creates a static rendition (i.e. MP4) for an asset
160
+ # @param asset_id [String] The asset ID.
161
+ # @param create_static_rendition_request [CreateStaticRenditionRequest]
162
+ # @param [Hash] opts the optional parameters
163
+ # @return [CreateStaticRenditionResponse]
164
+ def create_asset_static_rendition(asset_id, create_static_rendition_request, opts = {})
165
+ data, _status_code, _headers = create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request, opts)
166
+ data
167
+ end
168
+
169
+ # Create a static rendition for an asset
170
+ # Creates a static rendition (i.e. MP4) for an asset
171
+ # @param asset_id [String] The asset ID.
172
+ # @param create_static_rendition_request [CreateStaticRenditionRequest]
173
+ # @param [Hash] opts the optional parameters
174
+ # @return [Array<(CreateStaticRenditionResponse, Integer, Hash)>] CreateStaticRenditionResponse data, response status code and response headers
175
+ def create_asset_static_rendition_with_http_info(asset_id, create_static_rendition_request, opts = {})
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug 'Calling API: AssetsApi.create_asset_static_rendition ...'
178
+ end
179
+ # verify the required parameter 'asset_id' is set
180
+ if @api_client.config.client_side_validation && asset_id.nil?
181
+ fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.create_asset_static_rendition"
182
+ end
183
+ # verify the required parameter 'create_static_rendition_request' is set
184
+ if @api_client.config.client_side_validation && create_static_rendition_request.nil?
185
+ fail ArgumentError, "Missing the required parameter 'create_static_rendition_request' when calling AssetsApi.create_asset_static_rendition"
186
+ end
187
+ # resource path
188
+ local_var_path = '/video/v1/assets/{ASSET_ID}/static-renditions'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s))
189
+
190
+ # query parameters
191
+ query_params = opts[:query_params] || {}
192
+
193
+ # header parameters
194
+ header_params = opts[:header_params] || {}
195
+ # HTTP header 'Accept' (if needed)
196
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
197
+ # HTTP header 'Content-Type'
198
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
199
+
200
+ # form parameters
201
+ form_params = opts[:form_params] || {}
202
+
203
+ # http body (model)
204
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_static_rendition_request)
205
+
206
+ # return_type
207
+ return_type = opts[:debug_return_type] || 'CreateStaticRenditionResponse'
208
+
209
+ # auth_names
210
+ auth_names = opts[:debug_auth_names] || ['accessToken']
211
+
212
+ new_options = opts.merge(
213
+ :operation => :"AssetsApi.create_asset_static_rendition",
214
+ :header_params => header_params,
215
+ :query_params => query_params,
216
+ :form_params => form_params,
217
+ :body => post_body,
218
+ :auth_names => auth_names,
219
+ :return_type => return_type
220
+ )
221
+
222
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug "API called: AssetsApi#create_asset_static_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
225
+ end
226
+ return data, status_code, headers
227
+ end
228
+
158
229
  # Create an asset track
159
230
  # Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.
160
231
  # @param asset_id [String] The asset ID.
@@ -354,6 +425,73 @@ module MuxRuby
354
425
  return data, status_code, headers
355
426
  end
356
427
 
428
+ # Delete a single static rendition for an asset
429
+ # Deletes a single static rendition for an asset
430
+ # @param asset_id [String] The asset ID.
431
+ # @param static_rendition_id [String] The static rendition ID.
432
+ # @param [Hash] opts the optional parameters
433
+ # @return [nil]
434
+ def delete_asset_static_rendition(asset_id, static_rendition_id, opts = {})
435
+ delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id, opts)
436
+ nil
437
+ end
438
+
439
+ # Delete a single static rendition for an asset
440
+ # Deletes a single static rendition for an asset
441
+ # @param asset_id [String] The asset ID.
442
+ # @param static_rendition_id [String] The static rendition ID.
443
+ # @param [Hash] opts the optional parameters
444
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
445
+ def delete_asset_static_rendition_with_http_info(asset_id, static_rendition_id, opts = {})
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug 'Calling API: AssetsApi.delete_asset_static_rendition ...'
448
+ end
449
+ # verify the required parameter 'asset_id' is set
450
+ if @api_client.config.client_side_validation && asset_id.nil?
451
+ fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.delete_asset_static_rendition"
452
+ end
453
+ # verify the required parameter 'static_rendition_id' is set
454
+ if @api_client.config.client_side_validation && static_rendition_id.nil?
455
+ fail ArgumentError, "Missing the required parameter 'static_rendition_id' when calling AssetsApi.delete_asset_static_rendition"
456
+ end
457
+ # resource path
458
+ local_var_path = '/video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}'.sub('{' + 'ASSET_ID' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'STATIC_RENDITION_ID' + '}', CGI.escape(static_rendition_id.to_s))
459
+
460
+ # query parameters
461
+ query_params = opts[:query_params] || {}
462
+
463
+ # header parameters
464
+ header_params = opts[:header_params] || {}
465
+
466
+ # form parameters
467
+ form_params = opts[:form_params] || {}
468
+
469
+ # http body (model)
470
+ post_body = opts[:debug_body]
471
+
472
+ # return_type
473
+ return_type = opts[:debug_return_type]
474
+
475
+ # auth_names
476
+ auth_names = opts[:debug_auth_names] || ['accessToken']
477
+
478
+ new_options = opts.merge(
479
+ :operation => :"AssetsApi.delete_asset_static_rendition",
480
+ :header_params => header_params,
481
+ :query_params => query_params,
482
+ :form_params => form_params,
483
+ :body => post_body,
484
+ :auth_names => auth_names,
485
+ :return_type => return_type
486
+ )
487
+
488
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug "API called: AssetsApi#delete_asset_static_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
491
+ end
492
+ return data, status_code, headers
493
+ end
494
+
357
495
  # Delete an asset track
358
496
  # Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
359
497
  # @param asset_id [String] The asset ID.
@@ -905,7 +1043,7 @@ module MuxRuby
905
1043
  end
906
1044
 
907
1045
  # Update MP4 support
908
- # Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), 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.
1046
+ # This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), 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.
909
1047
  # @param asset_id [String] The asset ID.
910
1048
  # @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
911
1049
  # @param [Hash] opts the optional parameters
@@ -916,7 +1054,7 @@ module MuxRuby
916
1054
  end
917
1055
 
918
1056
  # Update MP4 support
919
- # Allows you to add or remove mp4 support for assets that were created without it. The values supported are &#x60;capped-1080p&#x60;, &#x60;audio-only&#x60;, &#x60;audio-only,capped-1080p&#x60;, &#x60;standard&#x60;(deprecated), and &#x60;none&#x60;. &#x60;none&#x60; means that an asset *does not* have mp4 support, so submitting a request with &#x60;mp4_support&#x60; set to &#x60;none&#x60; will delete the mp4 assets from the asset in question.
1057
+ # This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are &#x60;capped-1080p&#x60;, &#x60;audio-only&#x60;, &#x60;audio-only,capped-1080p&#x60;, &#x60;standard&#x60;(deprecated), and &#x60;none&#x60;. &#x60;none&#x60; means that an asset *does not* have mp4 support, so submitting a request with &#x60;mp4_support&#x60; set to &#x60;none&#x60; will delete the mp4 assets from the asset in question.
920
1058
  # @param asset_id [String] The asset ID.
921
1059
  # @param update_asset_mp4_support_request [UpdateAssetMP4SupportRequest]
922
1060
  # @param [Hash] opts the optional parameters
@@ -287,6 +287,67 @@ module MuxRuby
287
287
  return data, status_code, headers
288
288
  end
289
289
 
290
+ # Delete a live stream's static renditions setting for new assets
291
+ # Deletes a live stream's static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.
292
+ # @param live_stream_id [String] The live stream ID
293
+ # @param [Hash] opts the optional parameters
294
+ # @return [nil]
295
+ def delete_live_stream_new_asset_settings_static_renditions(live_stream_id, opts = {})
296
+ delete_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, opts)
297
+ nil
298
+ end
299
+
300
+ # Delete a live stream&#39;s static renditions setting for new assets
301
+ # Deletes a live stream&#39;s static renditions settings for new assets. Further assets made via this live stream will not create static renditions unless re-added.
302
+ # @param live_stream_id [String] The live stream ID
303
+ # @param [Hash] opts the optional parameters
304
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
305
+ def delete_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, opts = {})
306
+ if @api_client.config.debugging
307
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions ...'
308
+ end
309
+ # verify the required parameter 'live_stream_id' is set
310
+ if @api_client.config.client_side_validation && live_stream_id.nil?
311
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions"
312
+ end
313
+ # resource path
314
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
315
+
316
+ # query parameters
317
+ query_params = opts[:query_params] || {}
318
+
319
+ # header parameters
320
+ header_params = opts[:header_params] || {}
321
+
322
+ # form parameters
323
+ form_params = opts[:form_params] || {}
324
+
325
+ # http body (model)
326
+ post_body = opts[:debug_body]
327
+
328
+ # return_type
329
+ return_type = opts[:debug_return_type]
330
+
331
+ # auth_names
332
+ auth_names = opts[:debug_auth_names] || ['accessToken']
333
+
334
+ new_options = opts.merge(
335
+ :operation => :"LiveStreamsApi.delete_live_stream_new_asset_settings_static_renditions",
336
+ :header_params => header_params,
337
+ :query_params => query_params,
338
+ :form_params => form_params,
339
+ :body => post_body,
340
+ :auth_names => auth_names,
341
+ :return_type => return_type
342
+ )
343
+
344
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug "API called: LiveStreamsApi#delete_live_stream_new_asset_settings_static_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
347
+ end
348
+ return data, status_code, headers
349
+ end
350
+
290
351
  # Delete a live stream playback ID
291
352
  # Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.
292
353
  # @param live_stream_id [String] The live stream ID
@@ -1155,5 +1216,76 @@ module MuxRuby
1155
1216
  end
1156
1217
  return data, status_code, headers
1157
1218
  end
1219
+
1220
+ # Update live stream static renditions for new assets
1221
+ # Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.
1222
+ # @param live_stream_id [String] The live stream ID
1223
+ # @param update_live_stream_new_asset_settings_static_renditions_request [UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest]
1224
+ # @param [Hash] opts the optional parameters
1225
+ # @return [LiveStreamResponse]
1226
+ def update_live_stream_new_asset_settings_static_renditions(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts = {})
1227
+ data, _status_code, _headers = update_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts)
1228
+ data
1229
+ end
1230
+
1231
+ # Update live stream static renditions for new assets
1232
+ # Updates a live stream&#39;s static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.
1233
+ # @param live_stream_id [String] The live stream ID
1234
+ # @param update_live_stream_new_asset_settings_static_renditions_request [UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest]
1235
+ # @param [Hash] opts the optional parameters
1236
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
1237
+ def update_live_stream_new_asset_settings_static_renditions_with_http_info(live_stream_id, update_live_stream_new_asset_settings_static_renditions_request, opts = {})
1238
+ if @api_client.config.debugging
1239
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions ...'
1240
+ end
1241
+ # verify the required parameter 'live_stream_id' is set
1242
+ if @api_client.config.client_side_validation && live_stream_id.nil?
1243
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions"
1244
+ end
1245
+ # verify the required parameter 'update_live_stream_new_asset_settings_static_renditions_request' is set
1246
+ if @api_client.config.client_side_validation && update_live_stream_new_asset_settings_static_renditions_request.nil?
1247
+ fail ArgumentError, "Missing the required parameter 'update_live_stream_new_asset_settings_static_renditions_request' when calling LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions"
1248
+ end
1249
+ # resource path
1250
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
1251
+
1252
+ # query parameters
1253
+ query_params = opts[:query_params] || {}
1254
+
1255
+ # header parameters
1256
+ header_params = opts[:header_params] || {}
1257
+ # HTTP header 'Accept' (if needed)
1258
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1259
+ # HTTP header 'Content-Type'
1260
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1261
+
1262
+ # form parameters
1263
+ form_params = opts[:form_params] || {}
1264
+
1265
+ # http body (model)
1266
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_new_asset_settings_static_renditions_request)
1267
+
1268
+ # return_type
1269
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
1270
+
1271
+ # auth_names
1272
+ auth_names = opts[:debug_auth_names] || ['accessToken']
1273
+
1274
+ new_options = opts.merge(
1275
+ :operation => :"LiveStreamsApi.update_live_stream_new_asset_settings_static_renditions",
1276
+ :header_params => header_params,
1277
+ :query_params => query_params,
1278
+ :form_params => form_params,
1279
+ :body => post_body,
1280
+ :auth_names => auth_names,
1281
+ :return_type => return_type
1282
+ )
1283
+
1284
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1285
+ if @api_client.config.debugging
1286
+ @api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream_new_asset_settings_static_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1287
+ end
1288
+ return data, status_code, headers
1289
+ end
1158
1290
  end
1159
1291
  end
@@ -228,7 +228,7 @@ module MuxRuby
228
228
  if @api_client.config.debugging
229
229
  @api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
230
230
  end
231
- allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped"]
231
+ allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin", "video_creator_id"]
232
232
  if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
233
233
  fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
234
234
  end
@@ -323,7 +323,7 @@ module MuxRuby
323
323
  if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
324
324
  fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
325
325
  end
326
- allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped"]
326
+ allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin", "video_creator_id"]
327
327
  if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
328
328
  fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
329
329
  end
@@ -64,7 +64,7 @@ module MuxRuby
64
64
  # Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
65
65
  attr_accessor :is_live
66
66
 
67
- # Arbitrary user-supplied metadata set for the asset. Max 255 characters.
67
+ # You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
68
68
  attr_accessor :passthrough
69
69
 
70
70
  # Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
@@ -95,6 +95,8 @@ module MuxRuby
95
95
  # The type of ingest used to create the asset.
96
96
  attr_accessor :ingest_type
97
97
 
98
+ attr_accessor :meta
99
+
98
100
  class EnumAttributeValidator
99
101
  attr_reader :datatype
100
102
  attr_reader :allowable_values
@@ -148,7 +150,8 @@ module MuxRuby
148
150
  :'recording_times' => :'recording_times',
149
151
  :'non_standard_input_reasons' => :'non_standard_input_reasons',
150
152
  :'test' => :'test',
151
- :'ingest_type' => :'ingest_type'
153
+ :'ingest_type' => :'ingest_type',
154
+ :'meta' => :'meta'
152
155
  }
153
156
  end
154
157
 
@@ -188,7 +191,8 @@ module MuxRuby
188
191
  :'recording_times' => :'Array<AssetRecordingTimes>',
189
192
  :'non_standard_input_reasons' => :'AssetNonStandardInputReasons',
190
193
  :'test' => :'Boolean',
191
- :'ingest_type' => :'String'
194
+ :'ingest_type' => :'String',
195
+ :'meta' => :'AssetMetadata'
192
196
  }
193
197
  end
194
198
 
@@ -340,6 +344,10 @@ module MuxRuby
340
344
  if attributes.key?(:'ingest_type')
341
345
  self.ingest_type = attributes[:'ingest_type']
342
346
  end
347
+
348
+ if attributes.key?(:'meta')
349
+ self.meta = attributes[:'meta']
350
+ end
343
351
  end
344
352
 
345
353
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -496,7 +504,8 @@ module MuxRuby
496
504
  recording_times == o.recording_times &&
497
505
  non_standard_input_reasons == o.non_standard_input_reasons &&
498
506
  test == o.test &&
499
- ingest_type == o.ingest_type
507
+ ingest_type == o.ingest_type &&
508
+ meta == o.meta
500
509
  end
501
510
 
502
511
  # @see the `==` method
@@ -508,7 +517,7 @@ module MuxRuby
508
517
  # Calculates hash code according to all attributes.
509
518
  # @return [Integer] Hash code
510
519
  def hash
511
- [id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, video_quality, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test, ingest_type].hash
520
+ [id, created_at, status, duration, max_stored_resolution, resolution_tier, max_resolution_tier, encoding_tier, video_quality, max_stored_frame_rate, aspect_ratio, playback_ids, tracks, errors, per_title_encode, upload_id, is_live, passthrough, live_stream_id, master, master_access, mp4_support, source_asset_id, normalize_audio, static_renditions, recording_times, non_standard_input_reasons, test, ingest_type, meta].hash
512
521
  end
513
522
 
514
523
  # Builds the object from hash