Class: MuxRuby::TranscriptionVocabulariesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/transcription_vocabularies_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TranscriptionVocabulariesApi

Returns a new instance of TranscriptionVocabulariesApi.



19
20
21
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_transcription_vocabulary(create_transcription_vocabulary_request, opts = {}) ⇒ TranscriptionVocabularyResponse

Create a Transcription Vocabulary Create a new Transcription Vocabulary.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 27

def create_transcription_vocabulary(create_transcription_vocabulary_request, opts = {})
  data, _status_code, _headers = create_transcription_vocabulary_with_http_info(create_transcription_vocabulary_request, opts)
  data
end

#create_transcription_vocabulary_with_http_info(create_transcription_vocabulary_request, opts = {}) ⇒ Array<(TranscriptionVocabularyResponse, Integer, Hash)>

Create a Transcription Vocabulary Create a new Transcription Vocabulary.

Parameters:

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 37

def create_transcription_vocabulary_with_http_info(create_transcription_vocabulary_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranscriptionVocabulariesApi.create_transcription_vocabulary ...'
  end
  # verify the required parameter 'create_transcription_vocabulary_request' is set
  if @api_client.config.client_side_validation && create_transcription_vocabulary_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_transcription_vocabulary_request' when calling TranscriptionVocabulariesApi.create_transcription_vocabulary"
  end
  # resource path
  local_var_path = '/video/v1/transcription-vocabularies'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_transcription_vocabulary_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TranscriptionVocabularyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"TranscriptionVocabulariesApi.create_transcription_vocabulary",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranscriptionVocabulariesApi#create_transcription_vocabulary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_transcription_vocabulary(transcription_vocabulary_id, opts = {}) ⇒ nil

Delete a Transcription Vocabulary 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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 92

def delete_transcription_vocabulary(transcription_vocabulary_id, opts = {})
  delete_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts)
  nil
end

#delete_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Transcription Vocabulary Deletes a Transcription Vocabulary. The Transcription Vocabulary&#39;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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 102

def delete_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranscriptionVocabulariesApi.delete_transcription_vocabulary ...'
  end
  # verify the required parameter 'transcription_vocabulary_id' is set
  if @api_client.config.client_side_validation && transcription_vocabulary_id.nil?
    fail ArgumentError, "Missing the required parameter 'transcription_vocabulary_id' when calling TranscriptionVocabulariesApi.delete_transcription_vocabulary"
  end
  # resource path
  local_var_path = '/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'.sub('{' + 'TRANSCRIPTION_VOCABULARY_ID' + '}', CGI.escape(transcription_vocabulary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"TranscriptionVocabulariesApi.delete_transcription_vocabulary",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranscriptionVocabulariesApi#delete_transcription_vocabulary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transcription_vocabulary(transcription_vocabulary_id, opts = {}) ⇒ TranscriptionVocabularyResponse

Retrieve a Transcription Vocabulary 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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 153

def get_transcription_vocabulary(transcription_vocabulary_id, opts = {})
  data, _status_code, _headers = get_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts)
  data
end

#get_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts = {}) ⇒ Array<(TranscriptionVocabularyResponse, Integer, Hash)>

Retrieve a Transcription Vocabulary 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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 163

def get_transcription_vocabulary_with_http_info(transcription_vocabulary_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranscriptionVocabulariesApi.get_transcription_vocabulary ...'
  end
  # verify the required parameter 'transcription_vocabulary_id' is set
  if @api_client.config.client_side_validation && transcription_vocabulary_id.nil?
    fail ArgumentError, "Missing the required parameter 'transcription_vocabulary_id' when calling TranscriptionVocabulariesApi.get_transcription_vocabulary"
  end
  # resource path
  local_var_path = '/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'.sub('{' + 'TRANSCRIPTION_VOCABULARY_ID' + '}', CGI.escape(transcription_vocabulary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TranscriptionVocabularyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"TranscriptionVocabulariesApi.get_transcription_vocabulary",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranscriptionVocabulariesApi#get_transcription_vocabulary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transcription_vocabularies(opts = {}) ⇒ ListTranscriptionVocabulariesResponse

List Transcription Vocabularies List all Transcription Vocabularies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response (default to 10)

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

Returns:



217
218
219
220
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 217

def list_transcription_vocabularies(opts = {})
  data, _status_code, _headers = list_transcription_vocabularies_with_http_info(opts)
  data
end

#list_transcription_vocabularies_with_http_info(opts = {}) ⇒ Array<(ListTranscriptionVocabulariesResponse, Integer, Hash)>

List Transcription Vocabularies List all Transcription Vocabularies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 228

def list_transcription_vocabularies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranscriptionVocabulariesApi.list_transcription_vocabularies ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TranscriptionVocabulariesApi.list_transcription_vocabularies, must be smaller than or equal to 10.'
  end

  # resource path
  local_var_path = '/video/v1/transcription-vocabularies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListTranscriptionVocabulariesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"TranscriptionVocabulariesApi.list_transcription_vocabularies",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranscriptionVocabulariesApi#list_transcription_vocabularies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_transcription_vocabulary(transcription_vocabulary_id, update_transcription_vocabulary_request, opts = {}) ⇒ TranscriptionVocabularyResponse

Update a Transcription Vocabulary 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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • update_transcription_vocabulary_request (UpdateTranscriptionVocabularyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



284
285
286
287
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 284

def update_transcription_vocabulary(transcription_vocabulary_id, update_transcription_vocabulary_request, opts = {})
  data, _status_code, _headers = update_transcription_vocabulary_with_http_info(transcription_vocabulary_id, update_transcription_vocabulary_request, opts)
  data
end

#update_transcription_vocabulary_with_http_info(transcription_vocabulary_id, update_transcription_vocabulary_request, opts = {}) ⇒ Array<(TranscriptionVocabularyResponse, Integer, Hash)>

Update a Transcription Vocabulary 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.

Parameters:

  • transcription_vocabulary_id (String) —

    The ID of the Transcription Vocabulary.

  • update_transcription_vocabulary_request (UpdateTranscriptionVocabularyRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/mux_ruby/api/transcription_vocabularies_api.rb', line 295

def update_transcription_vocabulary_with_http_info(transcription_vocabulary_id, update_transcription_vocabulary_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TranscriptionVocabulariesApi.update_transcription_vocabulary ...'
  end
  # verify the required parameter 'transcription_vocabulary_id' is set
  if @api_client.config.client_side_validation && transcription_vocabulary_id.nil?
    fail ArgumentError, "Missing the required parameter 'transcription_vocabulary_id' when calling TranscriptionVocabulariesApi.update_transcription_vocabulary"
  end
  # verify the required parameter 'update_transcription_vocabulary_request' is set
  if @api_client.config.client_side_validation && update_transcription_vocabulary_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_transcription_vocabulary_request' when calling TranscriptionVocabulariesApi.update_transcription_vocabulary"
  end
  # resource path
  local_var_path = '/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'.sub('{' + 'TRANSCRIPTION_VOCABULARY_ID' + '}', CGI.escape(transcription_vocabulary_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_transcription_vocabulary_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TranscriptionVocabularyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"TranscriptionVocabulariesApi.update_transcription_vocabulary",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TranscriptionVocabulariesApi#update_transcription_vocabulary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end