mux_ruby 4.0.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 (52) 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/CreateAssetRequest.md +11 -5
  7. data/docs/CreateLiveStreamRequest.md +4 -2
  8. data/docs/PlaybackRestrictionsApi.md +1 -1
  9. data/docs/UpdateAssetRequest.md +4 -2
  10. data/docs/UpdateLiveStreamNewAssetSettings.md +3 -1
  11. data/docs/UpdateReferrerDomainRestrictionRequest.md +10 -37
  12. data/docs/Upload.md +1 -1
  13. data/docs/VideoView.md +3 -1
  14. data/examples/video/exercise-assets.rb +1 -1
  15. data/gen/generator-config.json +1 -1
  16. data/lib/mux_ruby/api/metrics_api.rb +2 -2
  17. data/lib/mux_ruby/models/asset.rb +14 -5
  18. data/lib/mux_ruby/models/asset_metadata.rb +284 -0
  19. data/lib/mux_ruby/models/create_asset_request.rb +41 -8
  20. data/lib/mux_ruby/models/create_live_stream_request.rb +15 -2
  21. data/lib/mux_ruby/models/update_asset_request.rb +14 -5
  22. data/lib/mux_ruby/models/update_live_stream_new_asset_settings.rb +13 -4
  23. data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +203 -73
  24. data/lib/mux_ruby/models/upload.rb +1 -1
  25. data/lib/mux_ruby/models/video_view.rb +15 -5
  26. data/lib/mux_ruby/version.rb +1 -1
  27. data/lib/mux_ruby.rb +1 -0
  28. data/spec/models/asset_metadata_spec.rb +46 -0
  29. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  30. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
  31. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/ffi_c.so +0 -0
  32. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +6 -6
  33. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/mkmf.log +16 -16
  34. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +6 -6
  35. 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
  36. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
  37. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
  38. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
  39. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
  40. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
  41. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
  42. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +3 -3
  43. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  44. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c/Makefile +3 -3
  45. data/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/lib/ffi_c.so +0 -0
  46. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler/Makefile +3 -3
  47. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  48. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +3 -3
  49. data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
  50. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +3 -3
  51. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
  52. metadata +169 -165
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 59c01c009b08ff1dc7d4d3a4921ff7029e30ba26ed010075fc596143aa45ad32
4
- data.tar.gz: b24d888bbcadb5c400caf51496debe8d45c58dfb98cbafe0830c427beb3b6239
3
+ metadata.gz: '087b7c6c59da33c71714712ee1158651bd38cbb88bdc052e4d839c4d58896346'
4
+ data.tar.gz: ee19833cef831324e1779e229034876b0344593ccb15067097cee86586dc55b1
5
5
  SHA512:
6
- metadata.gz: 209e22ebe53d4fdd348cf111350c2bf65688c7a5ac2f5e79e8f68ba0abdcad0bdbbc3d0b0e3ba18c81f42c2ec4504866d5c72de2a7948a3f4bf60178274db7ca
7
- data.tar.gz: 57d6aab465a4b1ed7a0ae9c3473d42f56342d6e3eb94670401dae9caa92de2a6a4d579637a2a339dc6ef5b12e9ea6d001b3c4eedd24e8dbd51dfbd6726d54af6
6
+ metadata.gz: 90a897216ad253c4116febcb63662a98943ffa81aaa7fec6764cb23d10a65f088d2d1c8419847c208835cc395a8c4d978c24e04d600f54e0f1c860e241211f7c
7
+ data.tar.gz: cfe7d908e2ba0b9746ce65afbf7c7f750cd806013d61869788dbe882076a05740386e1a3860a2a0964855c866d52dbdb9aa4ab8030e0a8e73f41063bb42ae701
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (4.0.0)
4
+ mux_ruby (5.0.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -23,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
23
23
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
24
24
 
25
25
  - API version: v1
26
- - Package version: 4.0.0
26
+ - Package version: 5.0.0
27
27
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
28
28
  For more information, please visit [https://docs.mux.com](https://docs.mux.com)
29
29
 
@@ -40,16 +40,16 @@ gem build mux_ruby.gemspec
40
40
  Then either install the gem locally:
41
41
 
42
42
  ```shell
43
- gem install ./mux_ruby-4.0.0.gem
43
+ gem install ./mux_ruby-5.0.0.gem
44
44
  ```
45
45
 
46
- (for development, run `gem install --dev ./mux_ruby-4.0.0.gem` to install the development dependencies)
46
+ (for development, run `gem install --dev ./mux_ruby-5.0.0.gem` to install the development dependencies)
47
47
 
48
48
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
49
49
 
50
50
  Finally add this to the Gemfile:
51
51
 
52
- gem 'mux_ruby', '~> 4.0.0'
52
+ gem 'mux_ruby', '~> 5.0.0'
53
53
 
54
54
  ### Install from Git
55
55
 
data/docs/Asset.md CHANGED
@@ -21,7 +21,7 @@
21
21
  | **per_title_encode** | **Boolean** | | [optional] |
22
22
  | **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] |
23
23
  | **is_live** | **Boolean** | 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. | [optional] |
24
- | **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
24
+ | **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**. | [optional] |
25
25
  | **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] |
26
26
  | **master** | [**AssetMaster**](AssetMaster.md) | | [optional] |
27
27
  | **master_access** | **String** | | [optional][default to 'none'] |
@@ -33,6 +33,7 @@
33
33
  | **non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) | | [optional] |
34
34
  | **test** | **Boolean** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] |
35
35
  | **ingest_type** | **String** | The type of ingest used to create the asset. | [optional] |
36
+ | **meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional] |
36
37
 
37
38
  ## Example
38
39
 
@@ -68,7 +69,8 @@ instance = MuxRuby::Asset.new(
68
69
  recording_times: null,
69
70
  non_standard_input_reasons: null,
70
71
  test: null,
71
- ingest_type: null
72
+ ingest_type: null,
73
+ meta: null
72
74
  )
73
75
  ```
74
76
 
@@ -0,0 +1,22 @@
1
+ # MuxRuby::AssetMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **title** | **String** | The video title. Max 512 code points. | [optional] |
8
+ | **creator_id** | **String** | This is an identifier you provide to keep track of the creator of the video. Max 128 code points. | [optional] |
9
+ | **external_id** | **String** | This is an identifier you provide to link the video to your own data. Max 128 code points. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::AssetMetadata.new(
17
+ title: null,
18
+ creator_id: null,
19
+ external_id: null
20
+ )
21
+ ```
22
+
@@ -4,11 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **input** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] |
8
- | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset). If no `playback_policy` is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
9
- | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. | [optional] |
7
+ | **input** | [**Array<InputSettings>**](InputSettings.md) | Deprecated. Use `inputs` instead, which accepts an identical type. | [optional] |
8
+ | **inputs** | [**Array<InputSettings>**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. | [optional] |
9
+ | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | Deprecated. Use `playback_policies` instead, which accepts an identical type. | [optional] |
10
+ | **playback_policies** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: * `\"public\"` (anyone with the playback URL can stream the asset). * `\"signed\"` (an additional access token is required to play the asset). If no `playback_policies` are set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
11
+ | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policies` when creating a DRM playback ID. | [optional] |
10
12
  | **per_title_encode** | **Boolean** | | [optional] |
11
- | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional] |
13
+ | **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**. | [optional] |
12
14
  | **mp4_support** | **String** | Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) for the updated API. Specify what level of support for mp4 playback. You may not enable both `mp4_support` and `static_renditions`. * 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). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
13
15
  | **normalize_audio** | **Boolean** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional][default to false] |
14
16
  | **master_access** | **String** | Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional] |
@@ -17,6 +19,7 @@
17
19
  | **encoding_tier** | **String** | This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional] |
18
20
  | **video_quality** | **String** | The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) | [optional] |
19
21
  | **static_renditions** | [**Array<CreateStaticRenditionRequest>**](CreateStaticRenditionRequest.md) | An array of static renditions to create for this asset. You may not enable both `static_renditions` and `mp4_support (the latter being deprecated)` | [optional] |
22
+ | **meta** | [**AssetMetadata**](AssetMetadata.md) | | [optional] |
20
23
 
21
24
  ## Example
22
25
 
@@ -25,7 +28,9 @@ require 'mux_ruby'
25
28
 
26
29
  instance = MuxRuby::CreateAssetRequest.new(
27
30
  input: null,
31
+ inputs: null,
28
32
  playback_policy: null,
33
+ playback_policies: null,
29
34
  advanced_playback_policies: null,
30
35
  per_title_encode: null,
31
36
  passthrough: null,
@@ -36,7 +41,8 @@ instance = MuxRuby::CreateAssetRequest.new(
36
41
  max_resolution_tier: null,
37
42
  encoding_tier: null,
38
43
  video_quality: null,
39
- static_renditions: null
44
+ static_renditions: null,
45
+ meta: null
40
46
  )
41
47
  ```
42
48
 
@@ -4,8 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | | [optional] |
8
- | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policy` when creating a DRM playback ID. | [optional] |
7
+ | **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | Deprecated. Use `playback_policies` instead, which accepts an identical type. | [optional] |
8
+ | **playback_policies** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this live stream and available through `playback_ids`. Options include: * `\"public\"` (anyone with the playback URL can stream the live stream). * `\"signed\"` (an additional access token is required to play the live stream). If no `playback_policies` is set, the live stream will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional] |
9
+ | **advanced_playback_policies** | [**Array<CreatePlaybackIDRequest>**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied on this live stream and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policies` when creating a DRM playback ID. | [optional] |
9
10
  | **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional] |
10
11
  | **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. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the `use_slate_for_standard_latency` option. | [optional][default to 60] |
11
12
  | **use_slate_for_standard_latency** | **Boolean** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional][default to false] |
@@ -28,6 +29,7 @@ require 'mux_ruby'
28
29
 
29
30
  instance = MuxRuby::CreateLiveStreamRequest.new(
30
31
  playback_policy: null,
32
+ playback_policies: null,
31
33
  advanced_playback_policies: null,
32
34
  new_asset_settings: null,
33
35
  reconnect_window: null,
@@ -317,7 +317,7 @@ end
317
317
 
318
318
  api_instance = MuxRuby::PlaybackRestrictionsApi.new
319
319
  playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
320
- update_referrer_domain_restriction_request = MuxRuby::ReferrerDomainRestriction.new # UpdateReferrerDomainRestrictionRequest |
320
+ update_referrer_domain_restriction_request = MuxRuby::UpdateReferrerDomainRestrictionRequest.new # UpdateReferrerDomainRestrictionRequest |
321
321
 
322
322
  begin
323
323
  # Update the Referrer Playback Restriction
@@ -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
 
@@ -7,6 +7,7 @@
7
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
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] |
10
11
 
11
12
  ## Example
12
13
 
@@ -16,7 +17,8 @@ require 'mux_ruby'
16
17
  instance = MuxRuby::UpdateLiveStreamNewAssetSettings.new(
17
18
  mp4_support: null,
18
19
  master_access: null,
19
- video_quality: null
20
+ video_quality: null,
21
+ meta: null
20
22
  )
21
23
  ```
22
24
 
@@ -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
@@ -182,6 +182,7 @@
182
182
  | **video_dynamic_range_type** | **String** | | [optional] |
183
183
  | **view_cdn_edge_pop** | **String** | | [optional] |
184
184
  | **view_cdn_origin** | **String** | | [optional] |
185
+ | **video_creator_id** | **String** | | [optional] |
185
186
 
186
187
  ## Example
187
188
 
@@ -366,7 +367,8 @@ instance = MuxRuby::VideoView.new(
366
367
  audio_codec: null,
367
368
  video_dynamic_range_type: null,
368
369
  view_cdn_edge_pop: null,
369
- view_cdn_origin: null
370
+ view_cdn_origin: null,
371
+ video_creator_id: null
370
372
  )
371
373
  ```
372
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": "4.0.0"
11
+ "gemVersion": "5.0.0"
12
12
  }
@@ -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", "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"]
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", "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"]
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