Class: PureCloud::UserRecordingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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.



7
8
9
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

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

Delete a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Returns:

  • (nil) 


267
268
269
270
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 267

def delete_recording_id(recording_id, opts = {})
  delete_recording_id_with_http_info(recording_id, opts)
  return nil
end

#delete_recording_id_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



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
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 277

def delete_recording_id_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi#delete_recording_id ..."
  end
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling delete_recording_id" if recording_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_id(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 (String) —

    conversation

Returns:



138
139
140
141
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 138

def get_recording_id(recording_id, opts = {})
  data, status_code, headers = get_recording_id_with_http_info(recording_id, opts)
  return data
end

#get_recording_id_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 format (WEBM, WAV, etc.)

Returns:



328
329
330
331
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 328

def get_recording_id_media(recording_id, opts = {})
  data, status_code, headers = get_recording_id_media_with_http_info(recording_id, opts)
  return data
end

#get_recording_id_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 format (WEBM, WAV, etc.)

Returns:

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

    DownloadResponse data, response status code and response headers



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
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 339

def get_recording_id_media_with_http_info(recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserRecordingsApi#get_recording_id_media ..."
  end
  
  # verify the required parameter 'recording_id' is set
  fail "Missing the required parameter 'recording_id' when calling get_recording_id_media" if recording_id.nil?
  
  if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WEBM, WAV'
  end
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_recording_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recording_id_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 (String) —

    conversation

Returns:

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

    UserRecording data, response status code and response headers



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

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

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_summary(opts = {}) ⇒ FaxSummary

Get user recording summary

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 80

def get_summary(opts = {})
  data, status_code, headers = get_summary_with_http_info(opts)
  return data
end

#get_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



89
90
91
92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 89

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_summary\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

  • :page_number (Integer) —

    Page number

  • :expand (String) —

    conversation

Returns:



18
19
20
21
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 18

def get_userrecordings(opts = {})
  data, status_code, headers = get_userrecordings_with_http_info(opts)
  return data
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 (String) —

    conversation

Returns:

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

    UserRecordingEntityListing data, response status code and response headers



30
31
32
33
34
35
36
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
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 30

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
  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'] = opts[:'expand'] if opts[:'expand']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_recording_id(recording_id, opts = {}) ⇒ UserRecording

Update a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :body (UserRecording) —

    UserRecording

  • :expand (String) —

    conversation

Returns:



203
204
205
206
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 203

def put_recording_id(recording_id, opts = {})
  data, status_code, headers = put_recording_id_with_http_info(recording_id, opts)
  return data
end

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

Update a user recording.

Parameters:

  • recording_id —

    User Recording ID

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

    the optional parameters

Options Hash (opts):

  • :body (UserRecording) —

    UserRecording

  • :expand (String) —

    conversation

Returns:

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

    UserRecording data, response status code and response headers



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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 215

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end