mux_ruby 3.4.0 → 3.5.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 (57) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +13 -7
  4. data/docs/Asset.md +1 -1
  5. data/docs/Broadcast.md +30 -0
  6. data/docs/BroadcastLayout.md +15 -0
  7. data/docs/BroadcastResolution.md +15 -0
  8. data/docs/BroadcastResponse.md +18 -0
  9. data/docs/BroadcastStatus.md +15 -0
  10. data/docs/CreateBroadcastRequest.md +26 -0
  11. data/docs/CreateSimulcastTargetRequest.md +1 -1
  12. data/docs/CreateSpaceRequest.md +22 -0
  13. data/docs/ListSpacesResponse.md +18 -0
  14. data/docs/Space.md +30 -0
  15. data/docs/SpaceResponse.md +18 -0
  16. data/docs/SpaceStatus.md +15 -0
  17. data/docs/SpaceType.md +15 -0
  18. data/docs/SpacesApi.md +658 -0
  19. data/docs/StartSpaceBroadcastResponse.md +18 -0
  20. data/docs/StopSpaceBroadcastResponse.md +18 -0
  21. data/gen/generator-config.json +1 -1
  22. data/gen/templates/README.mustache +9 -3
  23. data/lib/mux_ruby/api/spaces_api.rb +619 -0
  24. data/lib/mux_ruby/models/asset.rb +1 -1
  25. data/lib/mux_ruby/models/broadcast.rb +305 -0
  26. data/lib/mux_ruby/models/broadcast_layout.rb +37 -0
  27. data/lib/mux_ruby/models/broadcast_resolution.rb +41 -0
  28. data/lib/mux_ruby/models/broadcast_response.rb +223 -0
  29. data/lib/mux_ruby/models/broadcast_status.rb +37 -0
  30. data/lib/mux_ruby/models/create_broadcast_request.rb +266 -0
  31. data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
  32. data/lib/mux_ruby/models/create_space_request.rb +242 -0
  33. data/lib/mux_ruby/models/list_spaces_response.rb +225 -0
  34. data/lib/mux_ruby/models/space.rb +301 -0
  35. data/lib/mux_ruby/models/space_response.rb +223 -0
  36. data/lib/mux_ruby/models/space_status.rb +37 -0
  37. data/lib/mux_ruby/models/space_type.rb +36 -0
  38. data/lib/mux_ruby/models/start_space_broadcast_response.rb +218 -0
  39. data/lib/mux_ruby/models/stop_space_broadcast_response.rb +218 -0
  40. data/lib/mux_ruby/version.rb +1 -1
  41. data/lib/mux_ruby.rb +15 -0
  42. data/spec/api/spaces_api_spec.rb +149 -0
  43. data/spec/models/broadcast_layout_spec.rb +28 -0
  44. data/spec/models/broadcast_resolution_spec.rb +28 -0
  45. data/spec/models/broadcast_response_spec.rb +34 -0
  46. data/spec/models/broadcast_spec.rb +70 -0
  47. data/spec/models/broadcast_status_spec.rb +28 -0
  48. data/spec/models/create_broadcast_request_spec.rb +58 -0
  49. data/spec/models/create_space_request_spec.rb +46 -0
  50. data/spec/models/list_spaces_response_spec.rb +34 -0
  51. data/spec/models/space_response_spec.rb +34 -0
  52. data/spec/models/space_spec.rb +70 -0
  53. data/spec/models/space_status_spec.rb +28 -0
  54. data/spec/models/space_type_spec.rb +28 -0
  55. data/spec/models/start_space_broadcast_response_spec.rb +34 -0
  56. data/spec/models/stop_space_broadcast_response_spec.rb +34 -0
  57. metadata +164 -104
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1506fef11ec5ebfcc6b5ac3373c2ca2c91b6517d12b0e4c80355328d7c4ac592
4
- data.tar.gz: 1905ea66101553811136c0586b96a31e435ad119e97fcb60bfb60f8b7ffa6697
3
+ metadata.gz: f06799d3527381141aa85e61bb4ced77393cd093737749d367af058109ee1857
4
+ data.tar.gz: 31ba3d499a958823f814d721be3dc2673427a652f05d454b6ba24083204f6fe7
5
5
  SHA512:
6
- metadata.gz: 9604f459a5072ec8c4f8f30f3f0b14ce3a486d058c8382cb4d1414d511fdb24b9db6dd87ff1c5e51f0a0d4e1a1fdbf6772c9d6af9d4a18e99720b3e8da6d5a2a
7
- data.tar.gz: f77009abe3119763098c430d9c2899abd4cc116eed392617bbcd56215f2568c93a2f77cdc27aa7059897367f63d0b8e0b2aa74522f2e783f0b164de56e8f1d34
6
+ metadata.gz: 6d42942a820771f914aa2954e1317422f8960d89fac567729e6373ffb0157d6851cfb1080a655f934f779067adb7c9bfdbd9c54f060230a11901c50a931116b8
7
+ data.tar.gz: 869f8926e6f4e5f5b034ca5ae49f0b5713fd3b508feccf7bb61c22f48b5e8b5d1279bbb993dce76efad1414cc967172cc7f768a45634a66a6fd3d1c01ad73f5f
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mux_ruby (3.4.0)
4
+ mux_ruby (3.5.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -1,8 +1,14 @@
1
1
  ![Mux Ruby Banner](github-ruby-sdk.png)
2
2
 
3
- ![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
4
-
5
- MuxRuby - the Ruby gem for the Mux API
3
+ <p align="center">
4
+ <a href="https://rubygems.org/gems/mux_ruby"><img src="https://img.shields.io/gem/v/mux_ruby" title="RubyGems" /></a>
5
+ <a href="https://github.com/muxinc/mux-ruby/workflows/ci.yaml"><img src="https://github.com/muxinc/mux-ruby/actions/workflows/ci.yaml/badge.svg" title="CI" /></a>
6
+ </p>
7
+ <p align="center">
8
+ <a href="https://rubygems.org/gems/mux_ruby">RubyGems</a> |
9
+ <a href="https://docs.mux.com">Mux Docs</a> |
10
+ <a href="https://docs.mux.com/api-reference">Mux API Reference </a>
11
+ </p>
6
12
 
7
13
  # Mux Ruby
8
14
 
@@ -17,7 +23,7 @@ Not familiar with Mux? Check out https://mux.com/ for more information.
17
23
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
18
24
 
19
25
  - API version: v1
20
- - Package version: 3.4.0
26
+ - Package version: 3.5.0
21
27
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
22
28
  For more information, please visit [https://docs.mux.com](https://docs.mux.com)
23
29
 
@@ -34,16 +40,16 @@ gem build mux_ruby.gemspec
34
40
  Then either install the gem locally:
35
41
 
36
42
  ```shell
37
- gem install ./mux_ruby-3.4.0.gem
43
+ gem install ./mux_ruby-3.5.0.gem
38
44
  ```
39
45
 
40
- (for development, run `gem install --dev ./mux_ruby-3.4.0.gem` to install the development dependencies)
46
+ (for development, run `gem install --dev ./mux_ruby-3.5.0.gem` to install the development dependencies)
41
47
 
42
48
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
43
49
 
44
50
  Finally add this to the Gemfile:
45
51
 
46
- gem 'mux_ruby', '~> 3.4.0'
52
+ gem 'mux_ruby', '~> 3.5.0'
47
53
 
48
54
  ### Install from Git
49
55
 
data/docs/Asset.md CHANGED
@@ -16,7 +16,7 @@
16
16
  | **errors** | [**AssetErrors**](AssetErrors.md) | | [optional] |
17
17
  | **per_title_encode** | **Boolean** | | [optional] |
18
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] |
19
- | **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently &#x60;active&#x60; and not in &#x60;idle&#x60; state. | [optional] |
19
+ | **is_live** | **Boolean** | Indicates whether the live stream that created this asset is currently &#x60;active&#x60; and not in &#x60;idle&#x60; state. This is an optional parameter added when the asset is created from a live stream. | [optional] |
20
20
  | **passthrough** | **String** | Arbitrary user-supplied metadata set for the asset. Max 255 characters. | [optional] |
21
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] |
22
22
  | **master** | [**AssetMaster**](AssetMaster.md) | | [optional] |
data/docs/Broadcast.md ADDED
@@ -0,0 +1,30 @@
1
+ # MuxRuby::Broadcast
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the broadcast. Max 255 characters. | |
8
+ | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
9
+ | **live_stream_id** | **String** | The ID of the live stream that the broadcast will be sent to. | |
10
+ | **status** | [**BroadcastStatus**](BroadcastStatus.md) | | |
11
+ | **layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [default to &#39;gallery&#39;] |
12
+ | **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
13
+ | **resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [default to &#39;1920x1080&#39;] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mux_ruby'
19
+
20
+ instance = MuxRuby::Broadcast.new(
21
+ id: null,
22
+ passthrough: null,
23
+ live_stream_id: null,
24
+ status: null,
25
+ layout: null,
26
+ background: null,
27
+ resolution: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,15 @@
1
+ # MuxRuby::BroadcastLayout
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::BroadcastLayout.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # MuxRuby::BroadcastResolution
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::BroadcastResolution.new()
14
+ ```
15
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::BroadcastResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Broadcast**](Broadcast.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::BroadcastResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,15 @@
1
+ # MuxRuby::BroadcastStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::BroadcastStatus.new()
14
+ ```
15
+
@@ -0,0 +1,26 @@
1
+ # MuxRuby::CreateBroadcastRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters. | [optional] |
8
+ | **live_stream_id** | **String** | The ID of the live stream that you want to broadcast to. | |
9
+ | **layout** | [**BroadcastLayout**](BroadcastLayout.md) | | [optional][default to &#39;gallery&#39;] |
10
+ | **background** | **String** | URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution. | [optional] |
11
+ | **resolution** | [**BroadcastResolution**](BroadcastResolution.md) | | [optional][default to &#39;1920x1080&#39;] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mux_ruby'
17
+
18
+ instance = MuxRuby::CreateBroadcastRequest.new(
19
+ passthrough: null,
20
+ live_stream_id: null,
21
+ layout: null,
22
+ background: null,
23
+ resolution: null
24
+ )
25
+ ```
26
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **passthrough** | **String** | Arbitrary user-supplied metadata set by you when creating a simulcast target. | [optional] |
8
8
  | **stream_key** | **String** | Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. | [optional] |
9
- | **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: &#39;rtmp://live.example.com/app&#39;. | |
9
+ | **url** | **String** | RTMP hostname including application name for the third party live streaming service. Example: &#x60;rtmp://live.example.com/app&#x60;. | |
10
10
 
11
11
  ## Example
12
12
 
@@ -0,0 +1,22 @@
1
+ # MuxRuby::CreateSpaceRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**SpaceType**](SpaceType.md) | | [optional][default to &#39;server&#39;] |
8
+ | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
9
+ | **broadcasts** | [**Array&lt;CreateBroadcastRequest&gt;**](CreateBroadcastRequest.md) | An array of broadcast destinations you want to stream the space to. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::CreateSpaceRequest.new(
17
+ type: null,
18
+ passthrough: null,
19
+ broadcasts: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::ListSpacesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;Space&gt;**](Space.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::ListSpacesResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
data/docs/Space.md ADDED
@@ -0,0 +1,30 @@
1
+ # MuxRuby::Space
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the space. Max 255 characters. | |
8
+ | **created_at** | **String** | Time the space was created, defined as a Unix timestamp (seconds since epoch). | |
9
+ | **type** | [**SpaceType**](SpaceType.md) | | [default to &#39;server&#39;] |
10
+ | **status** | [**SpaceStatus**](SpaceStatus.md) | | |
11
+ | **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
12
+ | **broadcasts** | [**Array&lt;Broadcast&gt;**](Broadcast.md) | An array of broadcast destinations. | [optional] |
13
+ | **active_session_id** | **String** | Unique identifier for the current lifecycle of the space. Only set when the space is &#x60;active&#x60; and is set to a new value each time the space transitions from &#x60;idle&#x60; to &#x60;active&#x60;. This value is useful for logging and debugging issues. Max 255 characters. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mux_ruby'
19
+
20
+ instance = MuxRuby::Space.new(
21
+ id: null,
22
+ created_at: null,
23
+ type: null,
24
+ status: null,
25
+ passthrough: null,
26
+ broadcasts: null,
27
+ active_session_id: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::SpaceResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Space**](Space.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::SpaceResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,15 @@
1
+ # MuxRuby::SpaceStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::SpaceStatus.new()
14
+ ```
15
+
data/docs/SpaceType.md ADDED
@@ -0,0 +1,15 @@
1
+ # MuxRuby::SpaceType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'mux_ruby'
12
+
13
+ instance = MuxRuby::SpaceType.new()
14
+ ```
15
+