Class: PureCloud::WebChatApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/web_chat_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebChatApi

Returns a new instance of WebChatApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_webchat_deployment(deployment_id, opts = {}) ⇒ nil

Delete a WebChat deployment

Parameters:

  • deployment_id —

    Deployment Id

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 32

def delete_webchat_deployment(deployment_id, opts = {})
  delete_webchat_deployment_with_http_info(deployment_id, opts)
  return nil
end

#delete_webchat_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a WebChat deployment

Parameters:

  • deployment_id —

    Deployment 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/purecloudplatformclientv2/api/web_chat_api.rb', line 42

def delete_webchat_deployment_with_http_info(deployment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebChatApi.delete_webchat_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WebChatApi.delete_webchat_deployment" if deployment_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/webchat/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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: WebChatApi#delete_webchat_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webchat_settings(opts = {}) ⇒ nil

Remove WebChat deployment settings

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 95

def delete_webchat_settings(opts = {})
  delete_webchat_settings_with_http_info(opts)
  return nil
end

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

Remove WebChat deployment settings

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 104

def delete_webchat_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebChatApi.delete_webchat_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/webchat/settings".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(: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: WebChatApi#delete_webchat_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webchat_deployment(deployment_id, opts = {}) ⇒ WebChatDeployment

Get a WebChat deployment

Parameters:

  • deployment_id —

    Deployment Id

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 150

def get_webchat_deployment(deployment_id, opts = {})
  data, _status_code, _headers = get_webchat_deployment_with_http_info(deployment_id, opts)
  return data
end

#get_webchat_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(WebChatDeployment, Fixnum, Hash)>

Get a WebChat deployment

Parameters:

  • deployment_id —

    Deployment Id

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

    the optional parameters

Returns:

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

    WebChatDeployment data, response status code and response headers



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
201
202
203
204
205
206
207
208
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 160

def get_webchat_deployment_with_http_info(deployment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebChatApi.get_webchat_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WebChatApi.get_webchat_deployment" if deployment_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/webchat/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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(: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 => 'WebChatDeployment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebChatApi#get_webchat_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webchat_deployments(opts = {}) ⇒ WebChatDeploymentEntityListing

List WebChat deployments

Parameters:

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

    the optional parameters

Returns:



214
215
216
217
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 214

def get_webchat_deployments(opts = {})
  data, _status_code, _headers = get_webchat_deployments_with_http_info(opts)
  return data
end

#get_webchat_deployments_with_http_info(opts = {}) ⇒ Array<(WebChatDeploymentEntityListing, Fixnum, Hash)>

List WebChat deployments

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 223

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

#get_webchat_settings(opts = {}) ⇒ WebChatSettings

Get WebChat deployment settings

Parameters:

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

    the optional parameters

Returns:



269
270
271
272
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 269

def get_webchat_settings(opts = {})
  data, _status_code, _headers = get_webchat_settings_with_http_info(opts)
  return data
end

#get_webchat_settings_with_http_info(opts = {}) ⇒ Array<(WebChatSettings, Fixnum, Hash)>

Get WebChat deployment settings

Parameters:

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

    the optional parameters

Returns:

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

    WebChatSettings data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 278

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

#post_webchat_deployments(body, opts = {}) ⇒ WebChatDeployment

Create WebChat deployment

Parameters:

  • body —

    Deployment

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

    the optional parameters

Returns:



325
326
327
328
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 325

def post_webchat_deployments(body, opts = {})
  data, _status_code, _headers = post_webchat_deployments_with_http_info(body, opts)
  return data
end

#post_webchat_deployments_with_http_info(body, opts = {}) ⇒ Array<(WebChatDeployment, Fixnum, Hash)>

Create WebChat deployment

Parameters:

  • body —

    Deployment

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

    the optional parameters

Returns:

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

    WebChatDeployment data, response status code and response headers



335
336
337
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
379
380
381
382
383
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 335

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

#put_webchat_deployment(deployment_id, body, opts = {}) ⇒ WebChatDeployment

Update a WebChat deployment

Parameters:

  • deployment_id —

    Deployment Id

  • body —

    Deployment

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

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 391

def put_webchat_deployment(deployment_id, body, opts = {})
  data, _status_code, _headers = put_webchat_deployment_with_http_info(deployment_id, body, opts)
  return data
end

#put_webchat_deployment_with_http_info(deployment_id, body, opts = {}) ⇒ Array<(WebChatDeployment, Fixnum, Hash)>

Update a WebChat deployment

Parameters:

  • deployment_id —

    Deployment Id

  • body —

    Deployment

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

    the optional parameters

Returns:

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

    WebChatDeployment data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 402

def put_webchat_deployment_with_http_info(deployment_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebChatApi.put_webchat_deployment ..."
  end
  
  
  # verify the required parameter 'deployment_id' is set
  fail ArgumentError, "Missing the required parameter 'deployment_id' when calling WebChatApi.put_webchat_deployment" if deployment_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling WebChatApi.put_webchat_deployment" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/webchat/deployments/{deploymentId}".sub('{format}','json').sub('{' + 'deploymentId' + '}', deployment_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 = @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 => 'WebChatDeployment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebChatApi#put_webchat_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_webchat_settings(body, opts = {}) ⇒ WebChatSettings

Update WebChat deployment settings

Parameters:

  • body —

    webChatSettings

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

    the optional parameters

Returns:



465
466
467
468
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 465

def put_webchat_settings(body, opts = {})
  data, _status_code, _headers = put_webchat_settings_with_http_info(body, opts)
  return data
end

#put_webchat_settings_with_http_info(body, opts = {}) ⇒ Array<(WebChatSettings, Fixnum, Hash)>

Update WebChat deployment settings

Parameters:

  • body —

    webChatSettings

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

    the optional parameters

Returns:

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

    WebChatSettings 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
521
522
523
 
# File 'lib/purecloudplatformclientv2/api/web_chat_api.rb', line 475

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