mux_ruby 3.5.0 → 3.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +4 -4
  4. data/docs/CreateLiveStreamRequest.md +2 -0
  5. data/docs/CreateTranscriptionVocabularyRequest.md +22 -0
  6. data/docs/ListTranscriptionVocabulariesResponse.md +18 -0
  7. data/docs/LiveStream.md +3 -1
  8. data/docs/LiveStreamGeneratedSubtitleSettings.md +24 -0
  9. data/docs/LiveStreamsApi.md +73 -0
  10. data/docs/MetricsApi.md +1 -1
  11. data/docs/RealTimeApi.md +2 -2
  12. data/docs/SpacesApi.md +9 -9
  13. data/docs/Track.md +2 -0
  14. data/docs/TranscriptionVocabulariesApi.md +367 -0
  15. data/docs/TranscriptionVocabulary.md +28 -0
  16. data/docs/TranscriptionVocabularyResponse.md +18 -0
  17. data/docs/UpdateLiveStreamGeneratedSubtitlesRequest.md +18 -0
  18. data/docs/UpdateTranscriptionVocabularyRequest.md +22 -0
  19. data/docs/VideoView.md +11 -1
  20. data/gen/generator-config.json +1 -1
  21. data/gen/templates/partial_model_generic.mustache +2 -2
  22. data/lib/mux_ruby/api/live_streams_api.rb +71 -0
  23. data/lib/mux_ruby/api/metrics_api.rb +2 -2
  24. data/lib/mux_ruby/api/real_time_api.rb +2 -2
  25. data/lib/mux_ruby/api/spaces_api.rb +11 -11
  26. data/lib/mux_ruby/api/transcription_vocabularies_api.rb +349 -0
  27. data/lib/mux_ruby/models/create_live_stream_request.rb +18 -6
  28. data/lib/mux_ruby/models/create_transcription_vocabulary_request.rb +265 -0
  29. data/lib/mux_ruby/models/list_transcription_vocabularies_response.rb +220 -0
  30. data/lib/mux_ruby/models/live_stream.rb +14 -2
  31. data/lib/mux_ruby/models/live_stream_generated_subtitle_settings.rb +287 -0
  32. data/lib/mux_ruby/models/track.rb +23 -1
  33. data/lib/mux_ruby/models/transcription_vocabulary.rb +286 -0
  34. data/lib/mux_ruby/models/transcription_vocabulary_response.rb +218 -0
  35. data/lib/mux_ruby/models/update_live_stream_generated_subtitles_request.rb +221 -0
  36. data/lib/mux_ruby/models/update_live_stream_request.rb +5 -5
  37. data/lib/mux_ruby/models/update_transcription_vocabulary_request.rb +265 -0
  38. data/lib/mux_ruby/models/video_view.rb +55 -5
  39. data/lib/mux_ruby/version.rb +1 -1
  40. data/lib/mux_ruby.rb +8 -0
  41. data/spec/api/transcription_vocabularies_api_spec.rb +97 -0
  42. data/spec/models/create_transcription_vocabulary_request_spec.rb +46 -0
  43. data/spec/models/list_transcription_vocabularies_response_spec.rb +34 -0
  44. data/spec/models/live_stream_generated_subtitle_settings_spec.rb +56 -0
  45. data/spec/models/transcription_vocabulary_response_spec.rb +34 -0
  46. data/spec/models/transcription_vocabulary_spec.rb +64 -0
  47. data/spec/models/update_live_stream_generated_subtitles_request_spec.rb +34 -0
  48. data/spec/models/update_transcription_vocabulary_request_spec.rb +46 -0
  49. metadata +147 -115
@@ -0,0 +1,367 @@
1
+ # MuxRuby::TranscriptionVocabulariesApi
2
+
3
+ All URIs are relative to *https://api.mux.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_transcription_vocabulary**](TranscriptionVocabulariesApi.md#create_transcription_vocabulary) | **POST** /video/v1/transcription-vocabularies | Create a Transcription Vocabulary |
8
+ | [**delete_transcription_vocabulary**](TranscriptionVocabulariesApi.md#delete_transcription_vocabulary) | **DELETE** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Delete a Transcription Vocabulary |
9
+ | [**get_transcription_vocabulary**](TranscriptionVocabulariesApi.md#get_transcription_vocabulary) | **GET** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Retrieve a Transcription Vocabulary |
10
+ | [**list_transcription_vocabularies**](TranscriptionVocabulariesApi.md#list_transcription_vocabularies) | **GET** /video/v1/transcription-vocabularies | List Transcription Vocabularies |
11
+ | [**update_transcription_vocabulary**](TranscriptionVocabulariesApi.md#update_transcription_vocabulary) | **PUT** /video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID} | Update a Transcription Vocabulary |
12
+
13
+
14
+ ## create_transcription_vocabulary
15
+
16
+ > <TranscriptionVocabularyResponse> create_transcription_vocabulary(create_transcription_vocabulary_request)
17
+
18
+ Create a Transcription Vocabulary
19
+
20
+ Create a new Transcription Vocabulary.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'mux_ruby'
27
+ # setup authorization
28
+ MuxRuby.configure do |config|
29
+ # Configure HTTP basic authorization: accessToken
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+ end
33
+
34
+ api_instance = MuxRuby::TranscriptionVocabulariesApi.new
35
+ create_transcription_vocabulary_request = MuxRuby::CreateTranscriptionVocabularyRequest.new({phrases: ['phrases_example']}) # CreateTranscriptionVocabularyRequest |
36
+
37
+ begin
38
+ # Create a Transcription Vocabulary
39
+ result = api_instance.create_transcription_vocabulary(create_transcription_vocabulary_request)
40
+ p result
41
+ rescue MuxRuby::ApiError => e
42
+ puts "Error when calling TranscriptionVocabulariesApi->create_transcription_vocabulary: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_transcription_vocabulary_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<TranscriptionVocabularyResponse>, Integer, Hash)> create_transcription_vocabulary_with_http_info(create_transcription_vocabulary_request)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create a Transcription Vocabulary
55
+ data, status_code, headers = api_instance.create_transcription_vocabulary_with_http_info(create_transcription_vocabulary_request)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <TranscriptionVocabularyResponse>
59
+ rescue MuxRuby::ApiError => e
60
+ puts "Error when calling TranscriptionVocabulariesApi->create_transcription_vocabulary_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **create_transcription_vocabulary_request** | [**CreateTranscriptionVocabularyRequest**](CreateTranscriptionVocabularyRequest.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**TranscriptionVocabularyResponse**](TranscriptionVocabularyResponse.md)
73
+
74
+ ### Authorization
75
+
76
+ [accessToken](../README.md#accessToken)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## delete_transcription_vocabulary
85
+
86
+ > delete_transcription_vocabulary(transcription_vocabulary_id)
87
+
88
+ Delete a Transcription Vocabulary
89
+
90
+ Deletes a Transcription Vocabulary. The Transcription Vocabulary's ID will be disassociated from any live streams using it. Transcription Vocabularies can be deleted while associated live streams are active. However, the words and phrases in the deleted Transcription Vocabulary will remain attached to those streams while they are active.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'mux_ruby'
97
+ # setup authorization
98
+ MuxRuby.configure do |config|
99
+ # Configure HTTP basic authorization: accessToken
100
+ config.username = 'YOUR USERNAME'
101
+ config.password = 'YOUR PASSWORD'
102
+ end
103
+
104
+ api_instance = MuxRuby::TranscriptionVocabulariesApi.new
105
+ transcription_vocabulary_id = 'transcription_vocabulary_id_example' # String | The ID of the Transcription Vocabulary.
106
+
107
+ begin
108
+ # Delete a Transcription Vocabulary
109
+ api_instance.delete_transcription_vocabulary(transcription_vocabulary_id)
110
+ rescue MuxRuby::ApiError => e
111
+ puts "Error when calling TranscriptionVocabulariesApi->delete_transcription_vocabulary: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the delete_transcription_vocabulary_with_http_info variant
116
+
117
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
118
+
119
+ > <Array(nil, Integer, Hash)> delete_transcription_vocabulary_with_http_info(transcription_vocabulary_id)
120
+
121
+ ```ruby
122
+ begin
123
+ # Delete a Transcription Vocabulary
124
+ data, status_code, headers = api_instance.delete_transcription_vocabulary_with_http_info(transcription_vocabulary_id)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => nil
128
+ rescue MuxRuby::ApiError => e
129
+ puts "Error when calling TranscriptionVocabulariesApi->delete_transcription_vocabulary_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **transcription_vocabulary_id** | **String** | The ID of the Transcription Vocabulary. | |
138
+
139
+ ### Return type
140
+
141
+ nil (empty response body)
142
+
143
+ ### Authorization
144
+
145
+ [accessToken](../README.md#accessToken)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: Not defined
151
+
152
+
153
+ ## get_transcription_vocabulary
154
+
155
+ > <TranscriptionVocabularyResponse> get_transcription_vocabulary(transcription_vocabulary_id)
156
+
157
+ Retrieve a Transcription Vocabulary
158
+
159
+ Retrieves the details of a Transcription Vocabulary that has previously been created. Supply the unique Transcription Vocabulary ID and Mux will return the corresponding Transcription Vocabulary information. The same information is returned when creating a Transcription Vocabulary.
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'mux_ruby'
166
+ # setup authorization
167
+ MuxRuby.configure do |config|
168
+ # Configure HTTP basic authorization: accessToken
169
+ config.username = 'YOUR USERNAME'
170
+ config.password = 'YOUR PASSWORD'
171
+ end
172
+
173
+ api_instance = MuxRuby::TranscriptionVocabulariesApi.new
174
+ transcription_vocabulary_id = 'transcription_vocabulary_id_example' # String | The ID of the Transcription Vocabulary.
175
+
176
+ begin
177
+ # Retrieve a Transcription Vocabulary
178
+ result = api_instance.get_transcription_vocabulary(transcription_vocabulary_id)
179
+ p result
180
+ rescue MuxRuby::ApiError => e
181
+ puts "Error when calling TranscriptionVocabulariesApi->get_transcription_vocabulary: #{e}"
182
+ end
183
+ ```
184
+
185
+ #### Using the get_transcription_vocabulary_with_http_info variant
186
+
187
+ This returns an Array which contains the response data, status code and headers.
188
+
189
+ > <Array(<TranscriptionVocabularyResponse>, Integer, Hash)> get_transcription_vocabulary_with_http_info(transcription_vocabulary_id)
190
+
191
+ ```ruby
192
+ begin
193
+ # Retrieve a Transcription Vocabulary
194
+ data, status_code, headers = api_instance.get_transcription_vocabulary_with_http_info(transcription_vocabulary_id)
195
+ p status_code # => 2xx
196
+ p headers # => { ... }
197
+ p data # => <TranscriptionVocabularyResponse>
198
+ rescue MuxRuby::ApiError => e
199
+ puts "Error when calling TranscriptionVocabulariesApi->get_transcription_vocabulary_with_http_info: #{e}"
200
+ end
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ | Name | Type | Description | Notes |
206
+ | ---- | ---- | ----------- | ----- |
207
+ | **transcription_vocabulary_id** | **String** | The ID of the Transcription Vocabulary. | |
208
+
209
+ ### Return type
210
+
211
+ [**TranscriptionVocabularyResponse**](TranscriptionVocabularyResponse.md)
212
+
213
+ ### Authorization
214
+
215
+ [accessToken](../README.md#accessToken)
216
+
217
+ ### HTTP request headers
218
+
219
+ - **Content-Type**: Not defined
220
+ - **Accept**: application/json
221
+
222
+
223
+ ## list_transcription_vocabularies
224
+
225
+ > <ListTranscriptionVocabulariesResponse> list_transcription_vocabularies(opts)
226
+
227
+ List Transcription Vocabularies
228
+
229
+ List all Transcription Vocabularies.
230
+
231
+ ### Examples
232
+
233
+ ```ruby
234
+ require 'time'
235
+ require 'mux_ruby'
236
+ # setup authorization
237
+ MuxRuby.configure do |config|
238
+ # Configure HTTP basic authorization: accessToken
239
+ config.username = 'YOUR USERNAME'
240
+ config.password = 'YOUR PASSWORD'
241
+ end
242
+
243
+ api_instance = MuxRuby::TranscriptionVocabulariesApi.new
244
+ opts = {
245
+ limit: 56, # Integer | Number of items to include in the response
246
+ page: 56 # Integer | Offset by this many pages, of the size of `limit`
247
+ }
248
+
249
+ begin
250
+ # List Transcription Vocabularies
251
+ result = api_instance.list_transcription_vocabularies(opts)
252
+ p result
253
+ rescue MuxRuby::ApiError => e
254
+ puts "Error when calling TranscriptionVocabulariesApi->list_transcription_vocabularies: #{e}"
255
+ end
256
+ ```
257
+
258
+ #### Using the list_transcription_vocabularies_with_http_info variant
259
+
260
+ This returns an Array which contains the response data, status code and headers.
261
+
262
+ > <Array(<ListTranscriptionVocabulariesResponse>, Integer, Hash)> list_transcription_vocabularies_with_http_info(opts)
263
+
264
+ ```ruby
265
+ begin
266
+ # List Transcription Vocabularies
267
+ data, status_code, headers = api_instance.list_transcription_vocabularies_with_http_info(opts)
268
+ p status_code # => 2xx
269
+ p headers # => { ... }
270
+ p data # => <ListTranscriptionVocabulariesResponse>
271
+ rescue MuxRuby::ApiError => e
272
+ puts "Error when calling TranscriptionVocabulariesApi->list_transcription_vocabularies_with_http_info: #{e}"
273
+ end
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+ | Name | Type | Description | Notes |
279
+ | ---- | ---- | ----------- | ----- |
280
+ | **limit** | **Integer** | Number of items to include in the response | [optional][default to 10] |
281
+ | **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
282
+
283
+ ### Return type
284
+
285
+ [**ListTranscriptionVocabulariesResponse**](ListTranscriptionVocabulariesResponse.md)
286
+
287
+ ### Authorization
288
+
289
+ [accessToken](../README.md#accessToken)
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: Not defined
294
+ - **Accept**: application/json
295
+
296
+
297
+ ## update_transcription_vocabulary
298
+
299
+ > <TranscriptionVocabularyResponse> update_transcription_vocabulary(transcription_vocabulary_id, update_transcription_vocabulary_request)
300
+
301
+ Update a Transcription Vocabulary
302
+
303
+ Updates the details of a previously-created Transcription Vocabulary. Updates to Transcription Vocabularies are allowed while associated live streams are active. However, updates will not be applied to those streams while they are active.
304
+
305
+ ### Examples
306
+
307
+ ```ruby
308
+ require 'time'
309
+ require 'mux_ruby'
310
+ # setup authorization
311
+ MuxRuby.configure do |config|
312
+ # Configure HTTP basic authorization: accessToken
313
+ config.username = 'YOUR USERNAME'
314
+ config.password = 'YOUR PASSWORD'
315
+ end
316
+
317
+ api_instance = MuxRuby::TranscriptionVocabulariesApi.new
318
+ transcription_vocabulary_id = 'transcription_vocabulary_id_example' # String | The ID of the Transcription Vocabulary.
319
+ update_transcription_vocabulary_request = MuxRuby::UpdateTranscriptionVocabularyRequest.new({phrases: ['phrases_example']}) # UpdateTranscriptionVocabularyRequest |
320
+
321
+ begin
322
+ # Update a Transcription Vocabulary
323
+ result = api_instance.update_transcription_vocabulary(transcription_vocabulary_id, update_transcription_vocabulary_request)
324
+ p result
325
+ rescue MuxRuby::ApiError => e
326
+ puts "Error when calling TranscriptionVocabulariesApi->update_transcription_vocabulary: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the update_transcription_vocabulary_with_http_info variant
331
+
332
+ This returns an Array which contains the response data, status code and headers.
333
+
334
+ > <Array(<TranscriptionVocabularyResponse>, Integer, Hash)> update_transcription_vocabulary_with_http_info(transcription_vocabulary_id, update_transcription_vocabulary_request)
335
+
336
+ ```ruby
337
+ begin
338
+ # Update a Transcription Vocabulary
339
+ data, status_code, headers = api_instance.update_transcription_vocabulary_with_http_info(transcription_vocabulary_id, update_transcription_vocabulary_request)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => <TranscriptionVocabularyResponse>
343
+ rescue MuxRuby::ApiError => e
344
+ puts "Error when calling TranscriptionVocabulariesApi->update_transcription_vocabulary_with_http_info: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **transcription_vocabulary_id** | **String** | The ID of the Transcription Vocabulary. | |
353
+ | **update_transcription_vocabulary_request** | [**UpdateTranscriptionVocabularyRequest**](UpdateTranscriptionVocabularyRequest.md) | | |
354
+
355
+ ### Return type
356
+
357
+ [**TranscriptionVocabularyResponse**](TranscriptionVocabularyResponse.md)
358
+
359
+ ### Authorization
360
+
361
+ [accessToken](../README.md#accessToken)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: application/json
366
+ - **Accept**: application/json
367
+
@@ -0,0 +1,28 @@
1
+ # MuxRuby::TranscriptionVocabulary
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the Transcription Vocabulary | [optional] |
8
+ | **name** | **String** | The user-supplied name of the Transcription Vocabulary. | [optional] |
9
+ | **phrases** | **Array&lt;String&gt;** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream&#39;s &#x60;generated_subtitles&#x60; configuration, the probability of successful speech recognition for these words or phrases is boosted. | [optional] |
10
+ | **passthrough** | **String** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] |
11
+ | **created_at** | **String** | Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
12
+ | **updated_at** | **String** | Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch). | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'mux_ruby'
18
+
19
+ instance = MuxRuby::TranscriptionVocabulary.new(
20
+ id: null,
21
+ name: null,
22
+ phrases: null,
23
+ passthrough: null,
24
+ created_at: null,
25
+ updated_at: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::TranscriptionVocabularyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**TranscriptionVocabulary**](TranscriptionVocabulary.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::TranscriptionVocabularyResponse.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MuxRuby::UpdateLiveStreamGeneratedSubtitlesRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **generated_subtitles** | [**Array&lt;LiveStreamGeneratedSubtitleSettings&gt;**](LiveStreamGeneratedSubtitleSettings.md) | Update automated speech recognition subtitle configuration for a live stream. At most one subtitle track is allowed. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mux_ruby'
13
+
14
+ instance = MuxRuby::UpdateLiveStreamGeneratedSubtitlesRequest.new(
15
+ generated_subtitles: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # MuxRuby::UpdateTranscriptionVocabularyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The user-supplied name of the Transcription Vocabulary. | [optional] |
8
+ | **phrases** | **Array&lt;String&gt;** | Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream&#39;s &#x60;generated_subtitles&#x60;, the probability of successful speech recognition for these words or phrases is boosted. | |
9
+ | **passthrough** | **String** | Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mux_ruby'
15
+
16
+ instance = MuxRuby::UpdateTranscriptionVocabularyRequest.new(
17
+ name: null,
18
+ phrases: null,
19
+ passthrough: null
20
+ )
21
+ ```
22
+
data/docs/VideoView.md CHANGED
@@ -124,6 +124,11 @@
124
124
  | **viewer_connection_type** | **String** | | [optional] |
125
125
  | **viewer_device_model** | **String** | | [optional] |
126
126
  | **weighted_average_bitrate** | **Integer** | | [optional] |
127
+ | **custom_1** | **String** | | [optional] |
128
+ | **custom_2** | **String** | | [optional] |
129
+ | **custom_3** | **String** | | [optional] |
130
+ | **custom_4** | **String** | | [optional] |
131
+ | **custom_5** | **String** | | [optional] |
127
132
 
128
133
  ## Example
129
134
 
@@ -250,7 +255,12 @@ instance = MuxRuby::VideoView.new(
250
255
  view_session_id: null,
251
256
  viewer_connection_type: null,
252
257
  viewer_device_model: null,
253
- weighted_average_bitrate: null
258
+ weighted_average_bitrate: null,
259
+ custom_1: null,
260
+ custom_2: null,
261
+ custom_3: null,
262
+ custom_4: null,
263
+ custom_5: null
254
264
  )
255
265
  ```
256
266
 
@@ -8,5 +8,5 @@
8
8
  "gemSourceLocation": "https://github.com/muxinc/mux-ruby",
9
9
  "gemLicense": "MIT",
10
10
  "moduleName": "MuxRuby",
11
- "gemVersion": "3.5.0"
11
+ "gemVersion": "3.6.0"
12
12
  }
@@ -197,13 +197,13 @@
197
197
  {{/pattern}}
198
198
  {{#maxItems}}
199
199
  if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length > {{{maxItems}}}
200
- invalid_properties.push('invalid value for "{{{name}}}", number of items must be less than or equal to {{{maxItems}}}.'
200
+ invalid_properties.push('invalid value for "{{{name}}}", number of items must be less than or equal to {{{maxItems}}}.')
201
201
  end
202
202
 
203
203
  {{/maxItems}}
204
204
  {{#minItems}}
205
205
  if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length < {{{minItems}}}
206
- invalid_properties.push('invalid value for "{{{name}}}", number of items must be greater than or equal to {{{minItems}}}.'
206
+ invalid_properties.push('invalid value for "{{{name}}}", number of items must be greater than or equal to {{{minItems}}}.')
207
207
  end
208
208
 
209
209
  {{/minItems}}
@@ -1084,5 +1084,76 @@ module MuxRuby
1084
1084
  end
1085
1085
  return data, status_code, headers
1086
1086
  end
1087
+
1088
+ # Update a live stream's generated subtitles
1089
+ # Updates a live stream's automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload.
1090
+ # @param live_stream_id [String] The live stream ID
1091
+ # @param update_live_stream_generated_subtitles_request [UpdateLiveStreamGeneratedSubtitlesRequest]
1092
+ # @param [Hash] opts the optional parameters
1093
+ # @return [LiveStreamResponse]
1094
+ def update_live_stream_generated_subtitles(live_stream_id, update_live_stream_generated_subtitles_request, opts = {})
1095
+ data, _status_code, _headers = update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request, opts)
1096
+ data
1097
+ end
1098
+
1099
+ # Update a live stream&#39;s generated subtitles
1100
+ # Updates a live stream&#39;s automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload.
1101
+ # @param live_stream_id [String] The live stream ID
1102
+ # @param update_live_stream_generated_subtitles_request [UpdateLiveStreamGeneratedSubtitlesRequest]
1103
+ # @param [Hash] opts the optional parameters
1104
+ # @return [Array<(LiveStreamResponse, Integer, Hash)>] LiveStreamResponse data, response status code and response headers
1105
+ def update_live_stream_generated_subtitles_with_http_info(live_stream_id, update_live_stream_generated_subtitles_request, opts = {})
1106
+ if @api_client.config.debugging
1107
+ @api_client.config.logger.debug 'Calling API: LiveStreamsApi.update_live_stream_generated_subtitles ...'
1108
+ end
1109
+ # verify the required parameter 'live_stream_id' is set
1110
+ if @api_client.config.client_side_validation && live_stream_id.nil?
1111
+ fail ArgumentError, "Missing the required parameter 'live_stream_id' when calling LiveStreamsApi.update_live_stream_generated_subtitles"
1112
+ end
1113
+ # verify the required parameter 'update_live_stream_generated_subtitles_request' is set
1114
+ if @api_client.config.client_side_validation && update_live_stream_generated_subtitles_request.nil?
1115
+ fail ArgumentError, "Missing the required parameter 'update_live_stream_generated_subtitles_request' when calling LiveStreamsApi.update_live_stream_generated_subtitles"
1116
+ end
1117
+ # resource path
1118
+ local_var_path = '/video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles'.sub('{' + 'LIVE_STREAM_ID' + '}', CGI.escape(live_stream_id.to_s))
1119
+
1120
+ # query parameters
1121
+ query_params = opts[:query_params] || {}
1122
+
1123
+ # header parameters
1124
+ header_params = opts[:header_params] || {}
1125
+ # HTTP header 'Accept' (if needed)
1126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1127
+ # HTTP header 'Content-Type'
1128
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1129
+
1130
+ # form parameters
1131
+ form_params = opts[:form_params] || {}
1132
+
1133
+ # http body (model)
1134
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_live_stream_generated_subtitles_request)
1135
+
1136
+ # return_type
1137
+ return_type = opts[:debug_return_type] || 'LiveStreamResponse'
1138
+
1139
+ # auth_names
1140
+ auth_names = opts[:debug_auth_names] || ['accessToken']
1141
+
1142
+ new_options = opts.merge(
1143
+ :operation => :"LiveStreamsApi.update_live_stream_generated_subtitles",
1144
+ :header_params => header_params,
1145
+ :query_params => query_params,
1146
+ :form_params => form_params,
1147
+ :body => post_body,
1148
+ :auth_names => auth_names,
1149
+ :return_type => return_type
1150
+ )
1151
+
1152
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1153
+ if @api_client.config.debugging
1154
+ @api_client.config.logger.debug "API called: LiveStreamsApi#update_live_stream_generated_subtitles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1155
+ end
1156
+ return data, status_code, headers
1157
+ end
1087
1158
  end
1088
1159
  end
@@ -20,7 +20,7 @@ module MuxRuby
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get metric timeseries data
23
- # Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
23
+ # Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
24
24
  # @param metric_id [String] ID of the Metric
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
@@ -35,7 +35,7 @@ module MuxRuby
35
35
  end
36
36
 
37
37
  # Get metric timeseries data
38
- # Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
38
+ # Returns timeseries data for a specific metric. Each interval represented in the data array contains an array with the following values: * the first element is the interval time * the second element is the calculated metric value * the third element is the number of views in the interval that have a valid metric value
39
39
  # @param metric_id [String] ID of the Metric
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60;
@@ -24,7 +24,7 @@ module MuxRuby
24
24
  # @param realtime_metric_id [String] ID of the Realtime Metric
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :dimension Dimension the specified value belongs to
27
- # @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
27
+ # @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
28
28
  # @option opts [Array<String>] :filters 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;
29
29
  # @option opts [String] :order_by Value to order the results by
30
30
  # @option opts [String] :order_direction Sort order.
@@ -39,7 +39,7 @@ module MuxRuby
39
39
  # @param realtime_metric_id [String] ID of the Realtime Metric
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @option opts [String] :dimension Dimension the specified value belongs to
42
- # @option opts [Float] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
42
+ # @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
43
43
  # @option opts [Array<String>] :filters 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;
44
44
  # @option opts [String] :order_by Value to order the results by
45
45
  # @option opts [String] :order_direction Sort order.