mux_ruby 3.3.1 → 3.5.1

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 (98) 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/AssetNonStandardInputReasons.md +2 -2
  6. data/docs/AssetResponse.md +1 -1
  7. data/docs/AssetsApi.md +8 -0
  8. data/docs/Broadcast.md +30 -0
  9. data/docs/BroadcastLayout.md +15 -0
  10. data/docs/BroadcastResolution.md +15 -0
  11. data/docs/BroadcastResponse.md +18 -0
  12. data/docs/BroadcastStatus.md +15 -0
  13. data/docs/CreateBroadcastRequest.md +26 -0
  14. data/docs/CreateLiveStreamRequest.md +3 -1
  15. data/docs/CreatePlaybackIDResponse.md +1 -1
  16. data/docs/CreatePlaybackRestrictionRequest.md +1 -1
  17. data/docs/CreateSimulcastTargetRequest.md +1 -1
  18. data/docs/CreateSpaceRequest.md +22 -0
  19. data/docs/CreateTrackResponse.md +1 -1
  20. data/docs/DirectUploadsApi.md +6 -0
  21. data/docs/GetAssetPlaybackIDResponse.md +1 -1
  22. data/docs/GetLiveStreamPlaybackIDResponse.md +1 -1
  23. data/docs/IncidentResponse.md +1 -1
  24. data/docs/InputSettings.md +3 -3
  25. data/docs/ListSpacesResponse.md +18 -0
  26. data/docs/LiveStream.md +3 -1
  27. data/docs/LiveStreamResponse.md +1 -1
  28. data/docs/LiveStreamsApi.md +16 -4
  29. data/docs/MetricsApi.md +3 -3
  30. data/docs/PlaybackRestrictionResponse.md +1 -1
  31. data/docs/PlaybackRestrictionsApi.md +6 -6
  32. data/docs/RealTimeApi.md +2 -2
  33. data/docs/SigningKeyResponse.md +1 -1
  34. data/docs/SimulcastTargetResponse.md +1 -1
  35. data/docs/Space.md +30 -0
  36. data/docs/SpaceResponse.md +18 -0
  37. data/docs/SpaceStatus.md +15 -0
  38. data/docs/SpaceType.md +15 -0
  39. data/docs/SpacesApi.md +658 -0
  40. data/docs/StartSpaceBroadcastResponse.md +18 -0
  41. data/docs/StopSpaceBroadcastResponse.md +18 -0
  42. data/docs/Track.md +9 -7
  43. data/docs/UpdateLiveStreamRequest.md +3 -1
  44. data/docs/UpdateReferrerDomainRestrictionRequest.md +37 -5
  45. data/docs/UploadResponse.md +1 -1
  46. data/docs/VideoViewResponse.md +1 -1
  47. data/gen/generator-config.json +1 -1
  48. data/gen/templates/README.mustache +9 -3
  49. data/lib/mux_ruby/api/assets_api.rb +8 -0
  50. data/lib/mux_ruby/api/direct_uploads_api.rb +6 -0
  51. data/lib/mux_ruby/api/live_streams_api.rb +14 -2
  52. data/lib/mux_ruby/api/metrics_api.rb +5 -5
  53. data/lib/mux_ruby/api/playback_restrictions_api.rb +9 -9
  54. data/lib/mux_ruby/api/real_time_api.rb +2 -2
  55. data/lib/mux_ruby/api/spaces_api.rb +619 -0
  56. data/lib/mux_ruby/models/abridged_video_view.rb +7 -0
  57. data/lib/mux_ruby/models/asset.rb +1 -1
  58. data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +2 -2
  59. data/lib/mux_ruby/models/broadcast.rb +305 -0
  60. data/lib/mux_ruby/models/broadcast_layout.rb +37 -0
  61. data/lib/mux_ruby/models/broadcast_resolution.rb +41 -0
  62. data/lib/mux_ruby/models/broadcast_response.rb +223 -0
  63. data/lib/mux_ruby/models/broadcast_status.rb +37 -0
  64. data/lib/mux_ruby/models/create_broadcast_request.rb +266 -0
  65. data/lib/mux_ruby/models/create_live_stream_request.rb +40 -4
  66. data/lib/mux_ruby/models/create_simulcast_target_request.rb +1 -1
  67. data/lib/mux_ruby/models/create_space_request.rb +242 -0
  68. data/lib/mux_ruby/models/input_settings.rb +3 -3
  69. data/lib/mux_ruby/models/list_spaces_response.rb +225 -0
  70. data/lib/mux_ruby/models/live_stream.rb +40 -4
  71. data/lib/mux_ruby/models/space.rb +301 -0
  72. data/lib/mux_ruby/models/space_response.rb +223 -0
  73. data/lib/mux_ruby/models/space_status.rb +37 -0
  74. data/lib/mux_ruby/models/space_type.rb +36 -0
  75. data/lib/mux_ruby/models/start_space_broadcast_response.rb +218 -0
  76. data/lib/mux_ruby/models/stop_space_broadcast_response.rb +218 -0
  77. data/lib/mux_ruby/models/track.rb +32 -10
  78. data/lib/mux_ruby/models/update_live_stream_request.rb +40 -4
  79. data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb +74 -179
  80. data/lib/mux_ruby/models/video_view.rb +103 -0
  81. data/lib/mux_ruby/version.rb +1 -1
  82. data/lib/mux_ruby.rb +15 -0
  83. data/spec/api/spaces_api_spec.rb +149 -0
  84. data/spec/models/broadcast_layout_spec.rb +28 -0
  85. data/spec/models/broadcast_resolution_spec.rb +28 -0
  86. data/spec/models/broadcast_response_spec.rb +34 -0
  87. data/spec/models/broadcast_spec.rb +70 -0
  88. data/spec/models/broadcast_status_spec.rb +28 -0
  89. data/spec/models/create_broadcast_request_spec.rb +58 -0
  90. data/spec/models/create_space_request_spec.rb +46 -0
  91. data/spec/models/list_spaces_response_spec.rb +34 -0
  92. data/spec/models/space_response_spec.rb +34 -0
  93. data/spec/models/space_spec.rb +70 -0
  94. data/spec/models/space_status_spec.rb +28 -0
  95. data/spec/models/space_type_spec.rb +28 -0
  96. data/spec/models/start_space_broadcast_response_spec.rb +34 -0
  97. data/spec/models/stop_space_broadcast_response_spec.rb +34 -0
  98. metadata +159 -99
@@ -296,7 +296,7 @@ end
296
296
 
297
297
  ## update_referrer_domain_restriction
298
298
 
299
- > <PlaybackRestrictionResponse> update_referrer_domain_restriction(playback_restriction_id, body)
299
+ > <PlaybackRestrictionResponse> update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
300
300
 
301
301
  Update the Referrer Playback Restriction
302
302
 
@@ -316,11 +316,11 @@ end
316
316
 
317
317
  api_instance = MuxRuby::PlaybackRestrictionsApi.new
318
318
  playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
319
- body = {"allowed_domains":["*.example.com"],"allow_no_referrer":true} # ReferrerDomainRestriction |
319
+ update_referrer_domain_restriction_request = MuxRuby::ReferrerDomainRestriction.new # UpdateReferrerDomainRestrictionRequest |
320
320
 
321
321
  begin
322
322
  # Update the Referrer Playback Restriction
323
- result = api_instance.update_referrer_domain_restriction(playback_restriction_id, body)
323
+ result = api_instance.update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
324
324
  p result
325
325
  rescue MuxRuby::ApiError => e
326
326
  puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction: #{e}"
@@ -331,12 +331,12 @@ end
331
331
 
332
332
  This returns an Array which contains the response data, status code and headers.
333
333
 
334
- > <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
334
+ > <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
335
335
 
336
336
  ```ruby
337
337
  begin
338
338
  # Update the Referrer Playback Restriction
339
- data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
339
+ data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
340
340
  p status_code # => 2xx
341
341
  p headers # => { ... }
342
342
  p data # => <PlaybackRestrictionResponse>
@@ -350,7 +350,7 @@ end
350
350
  | Name | Type | Description | Notes |
351
351
  | ---- | ---- | ----------- | ----- |
352
352
  | **playback_restriction_id** | **String** | ID of the Playback Restriction. | |
353
- | **body** | **ReferrerDomainRestriction** | | |
353
+ | **update_referrer_domain_restriction_request** | [**UpdateReferrerDomainRestrictionRequest**](UpdateReferrerDomainRestrictionRequest.md) | | |
354
354
 
355
355
  ### Return type
356
356
 
data/docs/RealTimeApi.md CHANGED
@@ -35,7 +35,7 @@ api_instance = MuxRuby::RealTimeApi.new
35
35
  realtime_metric_id = 'current-concurrent-viewers' # String | ID of the Realtime Metric
36
36
  opts = {
37
37
  dimension: 'asn', # String | Dimension the specified value belongs to
38
- timestamp: 8.14, # Float | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
38
+ timestamp: 56, # Integer | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
39
39
  filters: ['inner_example'], # Array<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
40
40
  order_by: 'negative_impact', # String | Value to order the results by
41
41
  order_direction: 'asc' # String | Sort order.
@@ -74,7 +74,7 @@ end
74
74
  | ---- | ---- | ----------- | ----- |
75
75
  | **realtime_metric_id** | **String** | ID of the Realtime Metric | |
76
76
  | **dimension** | **String** | Dimension the specified value belongs to | [optional] |
77
- | **timestamp** | **Float** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
77
+ | **timestamp** | **Integer** | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. | [optional] |
78
78
  | **filters** | [**Array&lt;String&gt;**](String.md) | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional] |
79
79
  | **order_by** | **String** | Value to order the results by | [optional] |
80
80
  | **order_direction** | **String** | Sort order. | [optional] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**SigningKey**](.md) | | [optional] |
7
+ | **data** | [**SigningKey**](SigningKey.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**SimulcastTarget**](.md) | | [optional] |
7
+ | **data** | [**SimulcastTarget**](SimulcastTarget.md) | | [optional] |
8
8
 
9
9
  ## Example
10
10
 
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
+