Class: PureCloud::GreetingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/greetings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GreetingsApi

Returns a new instance of GreetingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_greeting_id(greeting_id, opts = {}) ⇒ Greeting

Deletes a Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Returns:



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

def delete_greeting_id(greeting_id, opts = {})
  data, status_code, headers = delete_greeting_id_with_http_info(greeting_id, opts)
  return data
end

#delete_greeting_id_with_http_info(greeting_id, opts = {}) ⇒ Array<(Greeting, Fixnum, Hash)>

Deletes a Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Returns:

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

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

def delete_greeting_id_with_http_info(greeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#delete_greeting_id ..."
  end
  
  # verify the required parameter 'greeting_id' is set
  fail "Missing the required parameter 'greeting_id' when calling delete_greeting_id" if greeting_id.nil?
  
  # resource path
  local_var_path = "/api/v2/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_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,
    :return_type => 'Greeting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#delete_greeting_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_defaults(opts = {}) ⇒ DefaultGreetingList

Get an Organization’s DefaultGreetingList

Parameters:

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/purecloud/api/greetings_api.rb', line 91

def get_defaults(opts = {})
  data, status_code, headers = get_defaults_with_http_info(opts)
  return data
end

#get_defaults_with_http_info(opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Get an Organization&#39;s DefaultGreetingList

Parameters:

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



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
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloud/api/greetings_api.rb', line 100

def get_defaults_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_defaults ..."
  end
  
  # resource path
  local_var_path = "/api/v2/greetings/defaults".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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_greeting_id(greeting_id, opts = {}) ⇒ Greeting

Get a Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/purecloud/api/greetings_api.rb', line 147

def get_greeting_id(greeting_id, opts = {})
  data, status_code, headers = get_greeting_id_with_http_info(greeting_id, opts)
  return data
end

#get_greeting_id_media(greeting_id, opts = {}) ⇒ GreetingMediaInfo

Get media playback URI for this greeting

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format. (default to WAV)

Returns:



208
209
210
211
 
# File 'lib/purecloud/api/greetings_api.rb', line 208

def get_greeting_id_media(greeting_id, opts = {})
  data, status_code, headers = get_greeting_id_media_with_http_info(greeting_id, opts)
  return data
end

#get_greeting_id_media_with_http_info(greeting_id, opts = {}) ⇒ Array<(GreetingMediaInfo, Fixnum, Hash)>

Get media playback URI for this greeting

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format.

Returns:

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

    GreetingMediaInfo data, response status code and response headers



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
261
262
263
264
265
266
267
 
# File 'lib/purecloud/api/greetings_api.rb', line 219

def get_greeting_id_media_with_http_info(greeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_greeting_id_media ..."
  end
  
  # verify the required parameter 'greeting_id' is set
  fail "Missing the required parameter 'greeting_id' when calling get_greeting_id_media" if greeting_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/greetings/{greetingId}/media".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_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 => 'GreetingMediaInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_greeting_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_greeting_id_with_http_info(greeting_id, opts = {}) ⇒ Array<(Greeting, Fixnum, Hash)>

Get a Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

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

    the optional parameters

Returns:

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

    Greeting data, response status code and response headers



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
195
196
197
198
199
200
 
# File 'lib/purecloud/api/greetings_api.rb', line 157

def get_greeting_id_with_http_info(greeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_greeting_id ..."
  end
  
  # verify the required parameter 'greeting_id' is set
  fail "Missing the required parameter 'greeting_id' when calling get_greeting_id" if greeting_id.nil?
  
  # resource path
  local_var_path = "/api/v2/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_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(: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 => 'Greeting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_greeting_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_greetings(opts = {}) ⇒ DomainEntityListing

Gets an Organization’s Greetings

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)

Returns:



275
276
277
278
 
# File 'lib/purecloud/api/greetings_api.rb', line 275

def get_greetings(opts = {})
  data, status_code, headers = get_greetings_with_http_info(opts)
  return data
end

#get_greetings_with_http_info(opts = {}) ⇒ Array<(DomainEntityListing, Fixnum, Hash)>

Gets an Organization&#39;s Greetings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    DomainEntityListing data, response status code and response headers



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
324
325
326
327
328
 
# File 'lib/purecloud/api/greetings_api.rb', line 286

def get_greetings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_greetings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/greetings".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']

  # 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 => 'DomainEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_id_greetings(group_id, opts = {}) ⇒ GreetingListing

Get a list of the Group’s Greetings

Parameters:

  • group_id —

    Group ID

  • 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)

Returns:



337
338
339
340
 
# File 'lib/purecloud/api/greetings_api.rb', line 337

def get_group_id_greetings(group_id, opts = {})
  data, status_code, headers = get_group_id_greetings_with_http_info(group_id, opts)
  return data
end

#get_group_id_greetings_defaults(group_id, opts = {}) ⇒ DefaultGreetingList

Grabs the list of Default Greetings given a Group’s ID

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:



401
402
403
404
 
# File 'lib/purecloud/api/greetings_api.rb', line 401

def get_group_id_greetings_defaults(group_id, opts = {})
  data, status_code, headers = get_group_id_greetings_defaults_with_http_info(group_id, opts)
  return data
end

#get_group_id_greetings_defaults_with_http_info(group_id, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Grabs the list of Default Greetings given a Group&#39;s ID

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



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

def get_group_id_greetings_defaults_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_group_id_greetings_defaults ..."
  end
  
  # verify the required parameter 'group_id' is set
  fail "Missing the required parameter 'group_id' when calling get_group_id_greetings_defaults" if group_id.nil?
  
  # resource path
  local_var_path = "/api/v2/groups/{groupId}/greetings/defaults".sub('{format}','json').sub('{' + 'groupId' + '}', group_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(: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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_group_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_id_greetings_with_http_info(group_id, opts = {}) ⇒ Array<(GreetingListing, Fixnum, Hash)>

Get a list of the Group&#39;s Greetings

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    GreetingListing data, response status code and response headers



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
389
390
391
392
393
394
 
# File 'lib/purecloud/api/greetings_api.rb', line 349

def get_group_id_greetings_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_group_id_greetings ..."
  end
  
  # verify the required parameter 'group_id' is set
  fail "Missing the required parameter 'group_id' when calling get_group_id_greetings" if group_id.nil?
  
  # resource path
  local_var_path = "/api/v2/groups/{groupId}/greetings".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # 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 => 'GreetingListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_group_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_id_greetings(user_id, opts = {}) ⇒ DomainEntityListing

Get a list of the User’s Greetings

Parameters:

  • user_id —

    User ID

  • 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)

Returns:



463
464
465
466
 
# File 'lib/purecloud/api/greetings_api.rb', line 463

def get_user_id_greetings(user_id, opts = {})
  data, status_code, headers = get_user_id_greetings_with_http_info(user_id, opts)
  return data
end

#get_user_id_greetings_defaults(user_id, opts = {}) ⇒ DefaultGreetingList

Grabs the list of Default Greetings given a User’s ID

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



527
528
529
530
 
# File 'lib/purecloud/api/greetings_api.rb', line 527

def get_user_id_greetings_defaults(user_id, opts = {})
  data, status_code, headers = get_user_id_greetings_defaults_with_http_info(user_id, opts)
  return data
end

#get_user_id_greetings_defaults_with_http_info(user_id, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Grabs the list of Default Greetings given a User&#39;s ID

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/purecloud/api/greetings_api.rb', line 537

def get_user_id_greetings_defaults_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_user_id_greetings_defaults ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_user_id_greetings_defaults" if user_id.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/greetings/defaults".sub('{format}','json').sub('{' + 'userId' + '}', user_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(: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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_user_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_id_greetings_with_http_info(user_id, opts = {}) ⇒ Array<(DomainEntityListing, Fixnum, Hash)>

Get a list of the User&#39;s Greetings

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    DomainEntityListing data, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/purecloud/api/greetings_api.rb', line 475

def get_user_id_greetings_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#get_user_id_greetings ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_user_id_greetings" if user_id.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/greetings".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # 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 => 'DomainEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#get_user_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_greetings(body, opts = {}) ⇒ DefaultGreetingList

Create a Greeting for an Organization

Parameters:

  • body —

    The Greeting to create

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

    the optional parameters

Returns:



587
588
589
590
 
# File 'lib/purecloud/api/greetings_api.rb', line 587

def post_greetings(body, opts = {})
  data, status_code, headers = post_greetings_with_http_info(body, opts)
  return data
end

#post_greetings_with_http_info(body, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Create a Greeting for an Organization

Parameters:

  • body —

    The Greeting to create

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/purecloud/api/greetings_api.rb', line 597

def post_greetings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#post_greetings ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_greetings" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/greetings".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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#post_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_group_id_greetings(group_id, body, opts = {}) ⇒ Greeting

Creates a Greeting for a Group

Parameters:

  • group_id —

    Group ID

  • body —

    The Greeting to create

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

    the optional parameters

Returns:



648
649
650
651
 
# File 'lib/purecloud/api/greetings_api.rb', line 648

def post_group_id_greetings(group_id, body, opts = {})
  data, status_code, headers = post_group_id_greetings_with_http_info(group_id, body, opts)
  return data
end

#post_group_id_greetings_with_http_info(group_id, body, opts = {}) ⇒ Array<(Greeting, Fixnum, Hash)>

Creates a Greeting for a Group

Parameters:

  • group_id —

    Group ID

  • body —

    The Greeting to create

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

    the optional parameters

Returns:

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

    Greeting data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/purecloud/api/greetings_api.rb', line 659

def post_group_id_greetings_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#post_group_id_greetings ..."
  end
  
  # verify the required parameter 'group_id' is set
  fail "Missing the required parameter 'group_id' when calling post_group_id_greetings" if group_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_group_id_greetings" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/groups/{groupId}/greetings".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Greeting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#post_group_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_user_id_greetings(user_id, body, opts = {}) ⇒ Greeting

Creates a Greeting for a User

Parameters:

  • user_id —

    User ID

  • body —

    The Greeting to create

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

    the optional parameters

Returns:



713
714
715
716
 
# File 'lib/purecloud/api/greetings_api.rb', line 713

def post_user_id_greetings(user_id, body, opts = {})
  data, status_code, headers = post_user_id_greetings_with_http_info(user_id, body, opts)
  return data
end

#post_user_id_greetings_with_http_info(user_id, body, opts = {}) ⇒ Array<(Greeting, Fixnum, Hash)>

Creates a Greeting for a User

Parameters:

  • user_id —

    User ID

  • body —

    The Greeting to create

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

    the optional parameters

Returns:

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

    Greeting data, response status code and response headers



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/purecloud/api/greetings_api.rb', line 724

def post_user_id_greetings_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#post_user_id_greetings ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling post_user_id_greetings" if user_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_user_id_greetings" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/greetings".sub('{format}','json').sub('{' + 'userId' + '}', user_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Greeting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#post_user_id_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_defaults(body, opts = {}) ⇒ DefaultGreetingList

Update an Organization’s DefaultGreetingList

Parameters:

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:



777
778
779
780
 
# File 'lib/purecloud/api/greetings_api.rb', line 777

def put_defaults(body, opts = {})
  data, status_code, headers = put_defaults_with_http_info(body, opts)
  return data
end

#put_defaults_with_http_info(body, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Update an Organization&#39;s DefaultGreetingList

Parameters:

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/purecloud/api/greetings_api.rb', line 787

def put_defaults_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#put_defaults ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_defaults" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/greetings/defaults".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 = @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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#put_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_greeting_id(greeting_id, body, opts = {}) ⇒ Greeting

Updates the Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

  • body —

    The updated Greeting

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

    the optional parameters

Returns:



838
839
840
841
 
# File 'lib/purecloud/api/greetings_api.rb', line 838

def put_greeting_id(greeting_id, body, opts = {})
  data, status_code, headers = put_greeting_id_with_http_info(greeting_id, body, opts)
  return data
end

#put_greeting_id_with_http_info(greeting_id, body, opts = {}) ⇒ Array<(Greeting, Fixnum, Hash)>

Updates the Greeting with the given GreetingId

Parameters:

  • greeting_id —

    Greeting ID

  • body —

    The updated Greeting

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

    the optional parameters

Returns:

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

    Greeting data, response status code and response headers



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/purecloud/api/greetings_api.rb', line 849

def put_greeting_id_with_http_info(greeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#put_greeting_id ..."
  end
  
  # verify the required parameter 'greeting_id' is set
  fail "Missing the required parameter 'greeting_id' when calling put_greeting_id" if greeting_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_greeting_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_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 = @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 => 'Greeting')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#put_greeting_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_group_id_greetings_defaults(group_id, body, opts = {}) ⇒ DefaultGreetingList

Updates the DefaultGreetingList of the specified Group

Parameters:

  • group_id —

    Group ID

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:



903
904
905
906
 
# File 'lib/purecloud/api/greetings_api.rb', line 903

def put_group_id_greetings_defaults(group_id, body, opts = {})
  data, status_code, headers = put_group_id_greetings_defaults_with_http_info(group_id, body, opts)
  return data
end

#put_group_id_greetings_defaults_with_http_info(group_id, body, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Updates the DefaultGreetingList of the specified Group

Parameters:

  • group_id —

    Group ID

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/purecloud/api/greetings_api.rb', line 914

def put_group_id_greetings_defaults_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#put_group_id_greetings_defaults ..."
  end
  
  # verify the required parameter 'group_id' is set
  fail "Missing the required parameter 'group_id' when calling put_group_id_greetings_defaults" if group_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_group_id_greetings_defaults" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/groups/{groupId}/greetings/defaults".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 = @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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#put_group_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_user_id_greetings_defaults(user_id, body, opts = {}) ⇒ DefaultGreetingList

Updates the DefaultGreetingList of the specified User

Parameters:

  • user_id —

    User ID

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:



968
969
970
971
 
# File 'lib/purecloud/api/greetings_api.rb', line 968

def put_user_id_greetings_defaults(user_id, body, opts = {})
  data, status_code, headers = put_user_id_greetings_defaults_with_http_info(user_id, body, opts)
  return data
end

#put_user_id_greetings_defaults_with_http_info(user_id, body, opts = {}) ⇒ Array<(DefaultGreetingList, Fixnum, Hash)>

Updates the DefaultGreetingList of the specified User

Parameters:

  • user_id —

    User ID

  • body —

    The updated defaultGreetingList

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

    the optional parameters

Returns:

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

    DefaultGreetingList data, response status code and response headers



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/purecloud/api/greetings_api.rb', line 979

def put_user_id_greetings_defaults_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GreetingsApi#put_user_id_greetings_defaults ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling put_user_id_greetings_defaults" if user_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_user_id_greetings_defaults" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/greetings/defaults".sub('{format}','json').sub('{' + 'userId' + '}', user_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 = @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 => 'DefaultGreetingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GreetingsApi#put_user_id_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end