mux_ruby 3.3.1 → 3.5.1

Sign up to get free protection for your applications and to get access to all the features.
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
data/docs/SpacesApi.md ADDED
@@ -0,0 +1,658 @@
1
+ # MuxRuby::SpacesApi
2
+
3
+ All URIs are relative to *https://api.mux.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_space**](SpacesApi.md#create_space) | **POST** /video/v1/spaces | Create a space |
8
+ | [**create_space_broadcast**](SpacesApi.md#create_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts | Create a space broadcast |
9
+ | [**delete_space**](SpacesApi.md#delete_space) | **DELETE** /video/v1/spaces/${SPACE_ID} | Delete a space |
10
+ | [**delete_space_broadcast**](SpacesApi.md#delete_space_broadcast) | **DELETE** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID} | Delete a space broadcast |
11
+ | [**get_space**](SpacesApi.md#get_space) | **GET** /video/v1/spaces/${SPACE_ID} | Retrieve a space |
12
+ | [**get_space_broadcast**](SpacesApi.md#get_space_broadcast) | **GET** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID} | Retrieve space broadcast |
13
+ | [**list_spaces**](SpacesApi.md#list_spaces) | **GET** /video/v1/spaces | List spaces |
14
+ | [**start_space_broadcast**](SpacesApi.md#start_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID}/start | Start a space broadcast |
15
+ | [**stop_space_broadcast**](SpacesApi.md#stop_space_broadcast) | **POST** /video/v1/spaces/${SPACE_ID}/broadcasts/${BROADCAST_ID}/stop | Stop a space broadcast |
16
+
17
+
18
+ ## create_space
19
+
20
+ > <SpaceResponse> create_space(create_space_request)
21
+
22
+ Create a space
23
+
24
+ Create a new space. Spaces are used to build [real-time video applications.](https://mux.com/real-time-video)
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ require 'time'
30
+ require 'mux_ruby'
31
+ # setup authorization
32
+ MuxRuby.configure do |config|
33
+ # Configure HTTP basic authorization: accessToken
34
+ config.username = 'YOUR USERNAME'
35
+ config.password = 'YOUR PASSWORD'
36
+ end
37
+
38
+ api_instance = MuxRuby::SpacesApi.new
39
+ create_space_request = MuxRuby::CreateSpaceRequest.new # CreateSpaceRequest |
40
+
41
+ begin
42
+ # Create a space
43
+ result = api_instance.create_space(create_space_request)
44
+ p result
45
+ rescue MuxRuby::ApiError => e
46
+ puts "Error when calling SpacesApi->create_space: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the create_space_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<SpaceResponse>, Integer, Hash)> create_space_with_http_info(create_space_request)
55
+
56
+ ```ruby
57
+ begin
58
+ # Create a space
59
+ data, status_code, headers = api_instance.create_space_with_http_info(create_space_request)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <SpaceResponse>
63
+ rescue MuxRuby::ApiError => e
64
+ puts "Error when calling SpacesApi->create_space_with_http_info: #{e}"
65
+ end
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ | Name | Type | Description | Notes |
71
+ | ---- | ---- | ----------- | ----- |
72
+ | **create_space_request** | [**CreateSpaceRequest**](CreateSpaceRequest.md) | | |
73
+
74
+ ### Return type
75
+
76
+ [**SpaceResponse**](SpaceResponse.md)
77
+
78
+ ### Authorization
79
+
80
+ [accessToken](../README.md#accessToken)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json
85
+ - **Accept**: application/json
86
+
87
+
88
+ ## create_space_broadcast
89
+
90
+ > <BroadcastResponse> create_space_broadcast(space_id, create_broadcast_request)
91
+
92
+ Create a space broadcast
93
+
94
+ Creates a new broadcast. Broadcasts are used to create composited versions of your space, which can be broadcast to live streams. **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more.
95
+
96
+ ### Examples
97
+
98
+ ```ruby
99
+ require 'time'
100
+ require 'mux_ruby'
101
+ # setup authorization
102
+ MuxRuby.configure do |config|
103
+ # Configure HTTP basic authorization: accessToken
104
+ config.username = 'YOUR USERNAME'
105
+ config.password = 'YOUR PASSWORD'
106
+ end
107
+
108
+ api_instance = MuxRuby::SpacesApi.new
109
+ space_id = 'space_id_example' # String | The space ID.
110
+ create_broadcast_request = MuxRuby::CreateBroadcastRequest.new({live_stream_id: 'live_stream_id_example'}) # CreateBroadcastRequest |
111
+
112
+ begin
113
+ # Create a space broadcast
114
+ result = api_instance.create_space_broadcast(space_id, create_broadcast_request)
115
+ p result
116
+ rescue MuxRuby::ApiError => e
117
+ puts "Error when calling SpacesApi->create_space_broadcast: #{e}"
118
+ end
119
+ ```
120
+
121
+ #### Using the create_space_broadcast_with_http_info variant
122
+
123
+ This returns an Array which contains the response data, status code and headers.
124
+
125
+ > <Array(<BroadcastResponse>, Integer, Hash)> create_space_broadcast_with_http_info(space_id, create_broadcast_request)
126
+
127
+ ```ruby
128
+ begin
129
+ # Create a space broadcast
130
+ data, status_code, headers = api_instance.create_space_broadcast_with_http_info(space_id, create_broadcast_request)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => <BroadcastResponse>
134
+ rescue MuxRuby::ApiError => e
135
+ puts "Error when calling SpacesApi->create_space_broadcast_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **space_id** | **String** | The space ID. | |
144
+ | **create_broadcast_request** | [**CreateBroadcastRequest**](CreateBroadcastRequest.md) | | |
145
+
146
+ ### Return type
147
+
148
+ [**BroadcastResponse**](BroadcastResponse.md)
149
+
150
+ ### Authorization
151
+
152
+ [accessToken](../README.md#accessToken)
153
+
154
+ ### HTTP request headers
155
+
156
+ - **Content-Type**: application/json
157
+ - **Accept**: application/json
158
+
159
+
160
+ ## delete_space
161
+
162
+ > delete_space(space_id)
163
+
164
+ Delete a space
165
+
166
+ Deletes a space. Spaces can only be deleted when `idle`.
167
+
168
+ ### Examples
169
+
170
+ ```ruby
171
+ require 'time'
172
+ require 'mux_ruby'
173
+ # setup authorization
174
+ MuxRuby.configure do |config|
175
+ # Configure HTTP basic authorization: accessToken
176
+ config.username = 'YOUR USERNAME'
177
+ config.password = 'YOUR PASSWORD'
178
+ end
179
+
180
+ api_instance = MuxRuby::SpacesApi.new
181
+ space_id = 'space_id_example' # String | The space ID.
182
+
183
+ begin
184
+ # Delete a space
185
+ api_instance.delete_space(space_id)
186
+ rescue MuxRuby::ApiError => e
187
+ puts "Error when calling SpacesApi->delete_space: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the delete_space_with_http_info variant
192
+
193
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
194
+
195
+ > <Array(nil, Integer, Hash)> delete_space_with_http_info(space_id)
196
+
197
+ ```ruby
198
+ begin
199
+ # Delete a space
200
+ data, status_code, headers = api_instance.delete_space_with_http_info(space_id)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => nil
204
+ rescue MuxRuby::ApiError => e
205
+ puts "Error when calling SpacesApi->delete_space_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **space_id** | **String** | The space ID. | |
214
+
215
+ ### Return type
216
+
217
+ nil (empty response body)
218
+
219
+ ### Authorization
220
+
221
+ [accessToken](../README.md#accessToken)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: Not defined
227
+
228
+
229
+ ## delete_space_broadcast
230
+
231
+ > delete_space_broadcast(space_id, broadcast_id)
232
+
233
+ Delete a space broadcast
234
+
235
+ Deletes a single broadcast of a specific space. Broadcasts can only be deleted when `idle`.
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'mux_ruby'
242
+ # setup authorization
243
+ MuxRuby.configure do |config|
244
+ # Configure HTTP basic authorization: accessToken
245
+ config.username = 'YOUR USERNAME'
246
+ config.password = 'YOUR PASSWORD'
247
+ end
248
+
249
+ api_instance = MuxRuby::SpacesApi.new
250
+ space_id = 'space_id_example' # String | The space ID.
251
+ broadcast_id = 'broadcast_id_example' # String | The broadcast ID.
252
+
253
+ begin
254
+ # Delete a space broadcast
255
+ api_instance.delete_space_broadcast(space_id, broadcast_id)
256
+ rescue MuxRuby::ApiError => e
257
+ puts "Error when calling SpacesApi->delete_space_broadcast: #{e}"
258
+ end
259
+ ```
260
+
261
+ #### Using the delete_space_broadcast_with_http_info variant
262
+
263
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
264
+
265
+ > <Array(nil, Integer, Hash)> delete_space_broadcast_with_http_info(space_id, broadcast_id)
266
+
267
+ ```ruby
268
+ begin
269
+ # Delete a space broadcast
270
+ data, status_code, headers = api_instance.delete_space_broadcast_with_http_info(space_id, broadcast_id)
271
+ p status_code # => 2xx
272
+ p headers # => { ... }
273
+ p data # => nil
274
+ rescue MuxRuby::ApiError => e
275
+ puts "Error when calling SpacesApi->delete_space_broadcast_with_http_info: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ | Name | Type | Description | Notes |
282
+ | ---- | ---- | ----------- | ----- |
283
+ | **space_id** | **String** | The space ID. | |
284
+ | **broadcast_id** | **String** | The broadcast ID. | |
285
+
286
+ ### Return type
287
+
288
+ nil (empty response body)
289
+
290
+ ### Authorization
291
+
292
+ [accessToken](../README.md#accessToken)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: Not defined
297
+ - **Accept**: Not defined
298
+
299
+
300
+ ## get_space
301
+
302
+ > <SpaceResponse> get_space(space_id)
303
+
304
+ Retrieve a space
305
+
306
+ Retrieves the details of a space that has previously been created. Supply the unique space ID that was returned from your create space request, and Mux will return the information about the corresponding space. The same information is returned when creating a space.
307
+
308
+ ### Examples
309
+
310
+ ```ruby
311
+ require 'time'
312
+ require 'mux_ruby'
313
+ # setup authorization
314
+ MuxRuby.configure do |config|
315
+ # Configure HTTP basic authorization: accessToken
316
+ config.username = 'YOUR USERNAME'
317
+ config.password = 'YOUR PASSWORD'
318
+ end
319
+
320
+ api_instance = MuxRuby::SpacesApi.new
321
+ space_id = 'space_id_example' # String | The space ID.
322
+
323
+ begin
324
+ # Retrieve a space
325
+ result = api_instance.get_space(space_id)
326
+ p result
327
+ rescue MuxRuby::ApiError => e
328
+ puts "Error when calling SpacesApi->get_space: #{e}"
329
+ end
330
+ ```
331
+
332
+ #### Using the get_space_with_http_info variant
333
+
334
+ This returns an Array which contains the response data, status code and headers.
335
+
336
+ > <Array(<SpaceResponse>, Integer, Hash)> get_space_with_http_info(space_id)
337
+
338
+ ```ruby
339
+ begin
340
+ # Retrieve a space
341
+ data, status_code, headers = api_instance.get_space_with_http_info(space_id)
342
+ p status_code # => 2xx
343
+ p headers # => { ... }
344
+ p data # => <SpaceResponse>
345
+ rescue MuxRuby::ApiError => e
346
+ puts "Error when calling SpacesApi->get_space_with_http_info: #{e}"
347
+ end
348
+ ```
349
+
350
+ ### Parameters
351
+
352
+ | Name | Type | Description | Notes |
353
+ | ---- | ---- | ----------- | ----- |
354
+ | **space_id** | **String** | The space ID. | |
355
+
356
+ ### Return type
357
+
358
+ [**SpaceResponse**](SpaceResponse.md)
359
+
360
+ ### Authorization
361
+
362
+ [accessToken](../README.md#accessToken)
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: Not defined
367
+ - **Accept**: application/json
368
+
369
+
370
+ ## get_space_broadcast
371
+
372
+ > <BroadcastResponse> get_space_broadcast(space_id, broadcast_id)
373
+
374
+ Retrieve space broadcast
375
+
376
+ Retrieves the details of a broadcast of a specific space.
377
+
378
+ ### Examples
379
+
380
+ ```ruby
381
+ require 'time'
382
+ require 'mux_ruby'
383
+ # setup authorization
384
+ MuxRuby.configure do |config|
385
+ # Configure HTTP basic authorization: accessToken
386
+ config.username = 'YOUR USERNAME'
387
+ config.password = 'YOUR PASSWORD'
388
+ end
389
+
390
+ api_instance = MuxRuby::SpacesApi.new
391
+ space_id = 'space_id_example' # String | The space ID.
392
+ broadcast_id = 'broadcast_id_example' # String | The broadcast ID.
393
+
394
+ begin
395
+ # Retrieve space broadcast
396
+ result = api_instance.get_space_broadcast(space_id, broadcast_id)
397
+ p result
398
+ rescue MuxRuby::ApiError => e
399
+ puts "Error when calling SpacesApi->get_space_broadcast: #{e}"
400
+ end
401
+ ```
402
+
403
+ #### Using the get_space_broadcast_with_http_info variant
404
+
405
+ This returns an Array which contains the response data, status code and headers.
406
+
407
+ > <Array(<BroadcastResponse>, Integer, Hash)> get_space_broadcast_with_http_info(space_id, broadcast_id)
408
+
409
+ ```ruby
410
+ begin
411
+ # Retrieve space broadcast
412
+ data, status_code, headers = api_instance.get_space_broadcast_with_http_info(space_id, broadcast_id)
413
+ p status_code # => 2xx
414
+ p headers # => { ... }
415
+ p data # => <BroadcastResponse>
416
+ rescue MuxRuby::ApiError => e
417
+ puts "Error when calling SpacesApi->get_space_broadcast_with_http_info: #{e}"
418
+ end
419
+ ```
420
+
421
+ ### Parameters
422
+
423
+ | Name | Type | Description | Notes |
424
+ | ---- | ---- | ----------- | ----- |
425
+ | **space_id** | **String** | The space ID. | |
426
+ | **broadcast_id** | **String** | The broadcast ID. | |
427
+
428
+ ### Return type
429
+
430
+ [**BroadcastResponse**](BroadcastResponse.md)
431
+
432
+ ### Authorization
433
+
434
+ [accessToken](../README.md#accessToken)
435
+
436
+ ### HTTP request headers
437
+
438
+ - **Content-Type**: Not defined
439
+ - **Accept**: application/json
440
+
441
+
442
+ ## list_spaces
443
+
444
+ > <ListSpacesResponse> list_spaces(opts)
445
+
446
+ List spaces
447
+
448
+ List all spaces in the current enviroment.
449
+
450
+ ### Examples
451
+
452
+ ```ruby
453
+ require 'time'
454
+ require 'mux_ruby'
455
+ # setup authorization
456
+ MuxRuby.configure do |config|
457
+ # Configure HTTP basic authorization: accessToken
458
+ config.username = 'YOUR USERNAME'
459
+ config.password = 'YOUR PASSWORD'
460
+ end
461
+
462
+ api_instance = MuxRuby::SpacesApi.new
463
+ opts = {
464
+ limit: 56, # Integer | Number of items to include in the response
465
+ page: 56 # Integer | Offset by this many pages, of the size of `limit`
466
+ }
467
+
468
+ begin
469
+ # List spaces
470
+ result = api_instance.list_spaces(opts)
471
+ p result
472
+ rescue MuxRuby::ApiError => e
473
+ puts "Error when calling SpacesApi->list_spaces: #{e}"
474
+ end
475
+ ```
476
+
477
+ #### Using the list_spaces_with_http_info variant
478
+
479
+ This returns an Array which contains the response data, status code and headers.
480
+
481
+ > <Array(<ListSpacesResponse>, Integer, Hash)> list_spaces_with_http_info(opts)
482
+
483
+ ```ruby
484
+ begin
485
+ # List spaces
486
+ data, status_code, headers = api_instance.list_spaces_with_http_info(opts)
487
+ p status_code # => 2xx
488
+ p headers # => { ... }
489
+ p data # => <ListSpacesResponse>
490
+ rescue MuxRuby::ApiError => e
491
+ puts "Error when calling SpacesApi->list_spaces_with_http_info: #{e}"
492
+ end
493
+ ```
494
+
495
+ ### Parameters
496
+
497
+ | Name | Type | Description | Notes |
498
+ | ---- | ---- | ----------- | ----- |
499
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
500
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
501
+
502
+ ### Return type
503
+
504
+ [**ListSpacesResponse**](ListSpacesResponse.md)
505
+
506
+ ### Authorization
507
+
508
+ [accessToken](../README.md#accessToken)
509
+
510
+ ### HTTP request headers
511
+
512
+ - **Content-Type**: Not defined
513
+ - **Accept**: application/json
514
+
515
+
516
+ ## start_space_broadcast
517
+
518
+ > <StartSpaceBroadcastResponse> start_space_broadcast(space_id, broadcast_id)
519
+
520
+ Start a space broadcast
521
+
522
+ Starts broadcasting a space to the associated destination. Broadcasts can only be started when the space is `active` (when there are participants connected).
523
+
524
+ ### Examples
525
+
526
+ ```ruby
527
+ require 'time'
528
+ require 'mux_ruby'
529
+ # setup authorization
530
+ MuxRuby.configure do |config|
531
+ # Configure HTTP basic authorization: accessToken
532
+ config.username = 'YOUR USERNAME'
533
+ config.password = 'YOUR PASSWORD'
534
+ end
535
+
536
+ api_instance = MuxRuby::SpacesApi.new
537
+ space_id = 'space_id_example' # String | The space ID.
538
+ broadcast_id = 'broadcast_id_example' # String | The broadcast ID.
539
+
540
+ begin
541
+ # Start a space broadcast
542
+ result = api_instance.start_space_broadcast(space_id, broadcast_id)
543
+ p result
544
+ rescue MuxRuby::ApiError => e
545
+ puts "Error when calling SpacesApi->start_space_broadcast: #{e}"
546
+ end
547
+ ```
548
+
549
+ #### Using the start_space_broadcast_with_http_info variant
550
+
551
+ This returns an Array which contains the response data, status code and headers.
552
+
553
+ > <Array(<StartSpaceBroadcastResponse>, Integer, Hash)> start_space_broadcast_with_http_info(space_id, broadcast_id)
554
+
555
+ ```ruby
556
+ begin
557
+ # Start a space broadcast
558
+ data, status_code, headers = api_instance.start_space_broadcast_with_http_info(space_id, broadcast_id)
559
+ p status_code # => 2xx
560
+ p headers # => { ... }
561
+ p data # => <StartSpaceBroadcastResponse>
562
+ rescue MuxRuby::ApiError => e
563
+ puts "Error when calling SpacesApi->start_space_broadcast_with_http_info: #{e}"
564
+ end
565
+ ```
566
+
567
+ ### Parameters
568
+
569
+ | Name | Type | Description | Notes |
570
+ | ---- | ---- | ----------- | ----- |
571
+ | **space_id** | **String** | The space ID. | |
572
+ | **broadcast_id** | **String** | The broadcast ID. | |
573
+
574
+ ### Return type
575
+
576
+ [**StartSpaceBroadcastResponse**](StartSpaceBroadcastResponse.md)
577
+
578
+ ### Authorization
579
+
580
+ [accessToken](../README.md#accessToken)
581
+
582
+ ### HTTP request headers
583
+
584
+ - **Content-Type**: Not defined
585
+ - **Accept**: application/json
586
+
587
+
588
+ ## stop_space_broadcast
589
+
590
+ > <StopSpaceBroadcastResponse> stop_space_broadcast(space_id, broadcast_id)
591
+
592
+ Stop a space broadcast
593
+
594
+ Stops broadcasting a space, causing the destination live stream to become idle. This API also automatically calls `complete` on the destination live stream. Broadcasts are also automatically stopped when a space becomes idle.
595
+
596
+ ### Examples
597
+
598
+ ```ruby
599
+ require 'time'
600
+ require 'mux_ruby'
601
+ # setup authorization
602
+ MuxRuby.configure do |config|
603
+ # Configure HTTP basic authorization: accessToken
604
+ config.username = 'YOUR USERNAME'
605
+ config.password = 'YOUR PASSWORD'
606
+ end
607
+
608
+ api_instance = MuxRuby::SpacesApi.new
609
+ space_id = 'space_id_example' # String | The space ID.
610
+ broadcast_id = 'broadcast_id_example' # String | The broadcast ID.
611
+
612
+ begin
613
+ # Stop a space broadcast
614
+ result = api_instance.stop_space_broadcast(space_id, broadcast_id)
615
+ p result
616
+ rescue MuxRuby::ApiError => e
617
+ puts "Error when calling SpacesApi->stop_space_broadcast: #{e}"
618
+ end
619
+ ```
620
+
621
+ #### Using the stop_space_broadcast_with_http_info variant
622
+
623
+ This returns an Array which contains the response data, status code and headers.
624
+
625
+ > <Array(<StopSpaceBroadcastResponse>, Integer, Hash)> stop_space_broadcast_with_http_info(space_id, broadcast_id)
626
+
627
+ ```ruby
628
+ begin
629
+ # Stop a space broadcast
630
+ data, status_code, headers = api_instance.stop_space_broadcast_with_http_info(space_id, broadcast_id)
631
+ p status_code # => 2xx
632
+ p headers # => { ... }
633
+ p data # => <StopSpaceBroadcastResponse>
634
+ rescue MuxRuby::ApiError => e
635
+ puts "Error when calling SpacesApi->stop_space_broadcast_with_http_info: #{e}"
636
+ end
637
+ ```
638
+
639
+ ### Parameters
640
+
641
+ | Name | Type | Description | Notes |
642
+ | ---- | ---- | ----------- | ----- |
643
+ | **space_id** | **String** | The space ID. | |
644
+ | **broadcast_id** | **String** | The broadcast ID. | |
645
+
646
+ ### Return type
647
+
648
+ [**StopSpaceBroadcastResponse**](StopSpaceBroadcastResponse.md)
649
+
650
+ ### Authorization
651
+
652
+ [accessToken](../README.md#accessToken)
653
+
654
+ ### HTTP request headers
655
+
656
+ - **Content-Type**: Not defined
657
+ - **Accept**: application/json
658
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::StartSpaceBroadcastResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::StartSpaceBroadcastResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::StopSpaceBroadcastResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::StopSpaceBroadcastResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+