Class: PureCloud::MessagingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagingApi

Returns a new instance of MessagingApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_messaging_integrations_facebook_integration_id(integration_id, opts = {}) ⇒ nil

Delete a Facebook messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_messaging_integrations_facebook_integration_id(integration_id, opts = {})
  delete_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts)
  return nil
end

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

Delete a Facebook messaging integration

Parameters:

  • integration_id —

    Integration 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/messaging_api.rb', line 42

def delete_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_facebook_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_facebook_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/facebook/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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: MessagingApi#delete_messaging_integrations_facebook_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_messaging_integrations_line_integration_id(integration_id, opts = {}) ⇒ nil

Delete a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 96

def delete_messaging_integrations_line_integration_id(integration_id, opts = {})
  delete_messaging_integrations_line_integration_id_with_http_info(integration_id, opts)
  return nil
end

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

Delete a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 106

def delete_messaging_integrations_line_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_line_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_line_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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: MessagingApi#delete_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_messaging_integrations_twitter_integration_id(integration_id, opts = {}) ⇒ nil

Delete a Twitter messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

  • (nil) 


160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 160

def delete_messaging_integrations_twitter_integration_id(integration_id, opts = {})
  delete_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts)
  return nil
end

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

Delete a Twitter messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
215
216
217
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 170

def delete_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_twitter_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_twitter_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/twitter/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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: MessagingApi#delete_messaging_integrations_twitter_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations(opts = {}) ⇒ MessagingIntegrationEntityListing

Get a list of Integrations

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:



225
226
227
228
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 225

def get_messaging_integrations(opts = {})
  data, _status_code, _headers = get_messaging_integrations_with_http_info(opts)
  return data
end

#get_messaging_integrations_facebook(opts = {}) ⇒ FacebookIntegrationEntityListing

Get a list of Facebook Integrations

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:



298
299
300
301
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 298

def get_messaging_integrations_facebook(opts = {})
  data, _status_code, _headers = get_messaging_integrations_facebook_with_http_info(opts)
  return data
end

#get_messaging_integrations_facebook_integration_id(integration_id, opts = {}) ⇒ FacebookIntegration

Get a Facebook messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 370

def get_messaging_integrations_facebook_integration_id(integration_id, opts = {})
  data, _status_code, _headers = get_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts)
  return data
end

#get_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts = {}) ⇒ Array<(FacebookIntegration, Fixnum, Hash)>

Get a Facebook messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

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

    FacebookIntegration data, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 380

def get_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_facebook_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_facebook_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/facebook/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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 => 'FacebookIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_facebook_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_facebook_with_http_info(opts = {}) ⇒ Array<(FacebookIntegrationEntityListing, Fixnum, Hash)>

Get a list of Facebook Integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
334
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
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 309

def get_messaging_integrations_facebook_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_facebook ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/facebook".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)
  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 OAuth']
  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 => 'FacebookIntegrationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_facebook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_line(opts = {}) ⇒ LineIntegrationEntityListing

Get a list of LINE messenger Integrations

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:



436
437
438
439
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 436

def get_messaging_integrations_line(opts = {})
  data, _status_code, _headers = get_messaging_integrations_line_with_http_info(opts)
  return data
end

#get_messaging_integrations_line_integration_id(integration_id, opts = {}) ⇒ LineIntegration

Get a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:



508
509
510
511
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 508

def get_messaging_integrations_line_integration_id(integration_id, opts = {})
  data, _status_code, _headers = get_messaging_integrations_line_integration_id_with_http_info(integration_id, opts)
  return data
end

#get_messaging_integrations_line_integration_id_with_http_info(integration_id, opts = {}) ⇒ Array<(LineIntegration, Fixnum, Hash)>

Get a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

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

    LineIntegration data, response status code and response headers



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
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
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 518

def get_messaging_integrations_line_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_line_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_line_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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 => 'LineIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_line_with_http_info(opts = {}) ⇒ Array<(LineIntegrationEntityListing, Fixnum, Hash)>

Get a list of LINE messenger Integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 447

def get_messaging_integrations_line_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_line ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/line".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)
  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 OAuth']
  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 => 'LineIntegrationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_twitter(opts = {}) ⇒ TwitterIntegrationEntityListing

Get a list of Twitter Integrations

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:



574
575
576
577
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 574

def get_messaging_integrations_twitter(opts = {})
  data, _status_code, _headers = get_messaging_integrations_twitter_with_http_info(opts)
  return data
end

#get_messaging_integrations_twitter_integration_id(integration_id, opts = {}) ⇒ TwitterIntegration

Get a Twitter messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:



646
647
648
649
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 646

def get_messaging_integrations_twitter_integration_id(integration_id, opts = {})
  data, _status_code, _headers = get_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts)
  return data
end

#get_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts = {}) ⇒ Array<(TwitterIntegration, Fixnum, Hash)>

Get a Twitter messaging integration

Parameters:

  • integration_id —

    Integration ID

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

    the optional parameters

Returns:

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

    TwitterIntegration data, response status code and response headers



656
657
658
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
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 656

def get_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_twitter_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_twitter_integration_id" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/twitter/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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 => 'TwitterIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_twitter_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_twitter_with_http_info(opts = {}) ⇒ Array<(TwitterIntegrationEntityListing, Fixnum, Hash)>

Get a list of Twitter Integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



585
586
587
588
589
590
591
592
593
594
595
596
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
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 585

def get_messaging_integrations_twitter_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_twitter ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/twitter".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)
  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 OAuth']
  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 => 'TwitterIntegrationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_twitter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_integrations_with_http_info(opts = {}) ⇒ Array<(MessagingIntegrationEntityListing, Fixnum, Hash)>

Get a list of Integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 236

def get_messaging_integrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations".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)
  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 OAuth']
  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 => 'MessagingIntegrationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messaging_sticker(messenger_type, opts = {}) ⇒ MessagingStickerEntityListing

Get a list of Messaging Stickers

Parameters:

  • messenger_type —

    Messenger Type

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



713
714
715
716
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 713

def get_messaging_sticker(messenger_type, opts = {})
  data, _status_code, _headers = get_messaging_sticker_with_http_info(messenger_type, opts)
  return data
end

#get_messaging_sticker_with_http_info(messenger_type, opts = {}) ⇒ Array<(MessagingStickerEntityListing, Fixnum, Hash)>

Get a list of Messaging Stickers

Parameters:

  • messenger_type —

    Messenger Type

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 725

def get_messaging_sticker_with_http_info(messenger_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_sticker ..."
  end
  
  
  # verify the required parameter 'messenger_type' is set
  fail ArgumentError, "Missing the required parameter 'messenger_type' when calling MessagingApi.get_messaging_sticker" if messenger_type.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/stickers/{messengerType}".sub('{format}','json').sub('{' + 'messengerType' + '}', messenger_type.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)
  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 OAuth']
  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 => 'MessagingStickerEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#get_messaging_sticker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messaging_integrations_facebook(body, opts = {}) ⇒ FacebookIntegration

Create a Facebook Integration

Parameters:

  • body —

    FacebookIntegrationRequest

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

    the optional parameters

Returns:



794
795
796
797
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 794

def post_messaging_integrations_facebook(body, opts = {})
  data, _status_code, _headers = post_messaging_integrations_facebook_with_http_info(body, opts)
  return data
end

#post_messaging_integrations_facebook_with_http_info(body, opts = {}) ⇒ Array<(FacebookIntegration, Fixnum, Hash)>

Create a Facebook Integration

Parameters:

  • body —

    FacebookIntegrationRequest

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

    the optional parameters

Returns:

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

    FacebookIntegration data, response status code and response headers



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
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 804

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

#post_messaging_integrations_line(body, opts = {}) ⇒ LineIntegration

Create a LINE messenger Integration

Parameters:

  • body —

    LineIntegrationRequest

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

    the optional parameters

Returns:



859
860
861
862
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 859

def post_messaging_integrations_line(body, opts = {})
  data, _status_code, _headers = post_messaging_integrations_line_with_http_info(body, opts)
  return data
end

#post_messaging_integrations_line_with_http_info(body, opts = {}) ⇒ Array<(LineIntegration, Fixnum, Hash)>

Create a LINE messenger Integration

Parameters:

  • body —

    LineIntegrationRequest

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

    the optional parameters

Returns:

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

    LineIntegration data, response status code and response headers



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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 869

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

#post_messaging_integrations_twitter(body, opts = {}) ⇒ TwitterIntegration

Create a Twitter Integration

Parameters:

  • body —

    TwitterIntegrationRequest

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

    the optional parameters

Returns:



924
925
926
927
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 924

def post_messaging_integrations_twitter(body, opts = {})
  data, _status_code, _headers = post_messaging_integrations_twitter_with_http_info(body, opts)
  return data
end

#post_messaging_integrations_twitter_with_http_info(body, opts = {}) ⇒ Array<(TwitterIntegration, Fixnum, Hash)>

Create a Twitter Integration

Parameters:

  • body —

    TwitterIntegrationRequest

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

    the optional parameters

Returns:

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

    TwitterIntegration data, response status code and response headers



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
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 934

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

#put_messaging_integrations_line_integration_id(integration_id, body, opts = {}) ⇒ LineIntegration

Update a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

  • body —

    LineIntegrationRequest

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

    the optional parameters

Returns:



990
991
992
993
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 990

def put_messaging_integrations_line_integration_id(integration_id, body, opts = {})
  data, _status_code, _headers = put_messaging_integrations_line_integration_id_with_http_info(integration_id, body, opts)
  return data
end

#put_messaging_integrations_line_integration_id_with_http_info(integration_id, body, opts = {}) ⇒ Array<(LineIntegration, Fixnum, Hash)>

Update a LINE messenger integration

Parameters:

  • integration_id —

    Integration ID

  • body —

    LineIntegrationRequest

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

    the optional parameters

Returns:

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

    LineIntegration data, response status code and response headers



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
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/purecloudplatformclientv2/api/messaging_api.rb', line 1001

def put_messaging_integrations_line_integration_id_with_http_info(integration_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagingApi.put_messaging_integrations_line_integration_id ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.put_messaging_integrations_line_integration_id" if integration_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.put_messaging_integrations_line_integration_id" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 OAuth']
  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 => 'LineIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagingApi#put_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end