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.



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

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) 


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

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



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

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
  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)
  _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, 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_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 (Array<String>) —

    Which fields, if any, to expand.

Returns:



92
93
94
95
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 92

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 media format. (default to WEBM)

Returns:



155
156
157
158
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 155

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 media format.

Returns:

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

    DownloadResponse data, response status code and response headers



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
210
211
212
213
214
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 166

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'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id'])
    fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, 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)
  _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, 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_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 (Array<String>) —

    Which fields, if any, to expand.

Returns:

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

    UserRecording data, response status code and response headers



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

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
  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)
  _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, 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_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:



220
221
222
223
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 220

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



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

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
  local_var_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, 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_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 (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



278
279
280
281
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 278

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

    Which fields, if any, to expand.

Returns:

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

    UserRecordingEntityListing data, response status code and response headers



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
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 290

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)
  _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, 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_recording_id(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:



342
343
344
345
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 342

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

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



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
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/purecloud/api/user_recordings_api.rb', line 354

def put_recording_id_with_http_info(recording_id, body, 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?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_recording_id" 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)
  _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(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_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end