Class: PureCloud::UserRecordingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/user_recordings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserRecordingsApi

Returns a new instance of UserRecordingsApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_userrecording(recording_id, opts = {}) ⇒ nil

Delete a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 32

def delete_userrecording(recording_id, opts = {})
  delete_userrecording_with_http_info(recording_id, opts)
  return nil
end

#delete_userrecording_with_http_info(recording_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
86
87
88
89
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 42

def delete_userrecording_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.delete_userrecording ..."
  end
  
  
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling UserRecordingsApi.delete_userrecording" if recording_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#delete_userrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_userrecording(recording_id, opts = {}) ⇒ UserRecording

Get a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



97
98
99
100
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 97

def get_userrecording(recording_id, opts = {})
  data, _status_code, _headers = get_userrecording_with_http_info(recording_id, opts)
  return data
end

#get_userrecording_media(recording_id, opts = {}) ⇒ DownloadResponse

Download a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format. (default to WEBM)

Returns:



171
172
173
174
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 171

def get_userrecording_media(recording_id, opts = {})
  data, _status_code, _headers = get_userrecording_media_with_http_info(recording_id, opts)
  return data
end

#get_userrecording_media_with_http_info(recording_id, opts = {}) ⇒ Array<(DownloadResponse, Fixnum, Hash)>

Download a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format.

Returns:

  • (Array<(DownloadResponse, Fixnum, Hash)>) —

    DownloadResponse data, response status code and response headers



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 182

def get_userrecording_media_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.get_userrecording_media ..."
  end
  
  
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling UserRecordingsApi.get_userrecording_media" if recording_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/userrecordings/{recordingId}/media".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DownloadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#get_userrecording_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_userrecording_with_http_info(recording_id, opts = {}) ⇒ Array<(UserRecording, Fixnum, Hash)>

Get a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:

  • (Array<(UserRecording, Fixnum, Hash)>) —

    UserRecording data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 108

def get_userrecording_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.get_userrecording ..."
  end
  
  
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling UserRecordingsApi.get_userrecording" if recording_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserRecording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#get_userrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_userrecordings(opts = {}) ⇒ UserRecordingEntityListing

Get a list of user recordings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



250
251
252
253
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 250

def get_userrecordings(opts = {})
  data, _status_code, _headers = get_userrecordings_with_http_info(opts)
  return data
end

#get_userrecordings_summary(opts = {}) ⇒ FaxSummary

Get user recording summary

Parameters:

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 329

def get_userrecordings_summary(opts = {})
  data, _status_code, _headers = get_userrecordings_summary_with_http_info(opts)
  return data
end

#get_userrecordings_summary_with_http_info(opts = {}) ⇒ Array<(FaxSummary, Fixnum, Hash)>

Get user recording summary

Parameters:

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

    the optional parameters

Returns:

  • (Array<(FaxSummary, Fixnum, Hash)>) —

    FaxSummary data, response status code and response headers



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 338

def get_userrecordings_summary_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.get_userrecordings_summary ..."
  end
  
  # resource path
  local_var_path = "/api/v2/userrecordings/summary".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FaxSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#get_userrecordings_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_userrecordings_with_http_info(opts = {}) ⇒ Array<(UserRecordingEntityListing, Fixnum, Hash)>

Get a list of user recordings.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:

  • (Array<(UserRecordingEntityListing, Fixnum, Hash)>) —

    UserRecordingEntityListing data, response status code and response headers



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
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
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 262

def get_userrecordings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.get_userrecordings ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/userrecordings".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserRecordingEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#get_userrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_userrecording(recording_id, body, opts = {}) ⇒ UserRecording

Update a user recording.

Parameters:

  • recording_id —

    User Recording ID

  • body —

    UserRecording

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



387
388
389
390
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 387

def put_userrecording(recording_id, body, opts = {})
  data, _status_code, _headers = put_userrecording_with_http_info(recording_id, body, opts)
  return data
end

#put_userrecording_with_http_info(recording_id, body, opts = {}) ⇒ Array<(UserRecording, Fixnum, Hash)>

Update a user recording.

Parameters:

  • recording_id —

    User Recording ID

  • body —

    UserRecording

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:

  • (Array<(UserRecording, Fixnum, Hash)>) —

    UserRecording data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/purecloudclient_v2a/api/user_recordings_api.rb', line 399

def put_userrecording_with_http_info(recording_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi.put_userrecording ..."
  end
  
  
  # verify the required parameter 'recording_id' is set
  fail ArgumentError, "Missing the required parameter 'recording_id' when calling UserRecordingsApi.put_userrecording" if recording_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling UserRecordingsApi.put_userrecording" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/userrecordings/{recordingId}".sub('{format}','json').sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserRecording')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserRecordingsApi#put_userrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end