Class: PureCloud::IntegrationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi

Returns a new instance of IntegrationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_integrations_action(action_id, opts = {}) ⇒ nil

Delete an Action

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_integrations_action(action_id, opts = {})
  delete_integrations_action_with_http_info(action_id, opts)
  return nil
end

#delete_integrations_action_draft(action_id, opts = {}) ⇒ nil

Delete a Draft

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_integrations_action_draft(action_id, opts = {})
  delete_integrations_action_draft_with_http_info(action_id, opts)
  return nil
end

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

Delete a Draft

Parameters:

  • action_id —

    actionId

  • 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/integrations_api.rb', line 106

def delete_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.delete_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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: IntegrationsApi#delete_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an Action

Parameters:

  • action_id —

    actionId

  • 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/integrations_api.rb', line 42

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

#get_integrations_action(action_id, opts = {}) ⇒ Action

Retrieves a single Action matching id.

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Indicates fields of the response which should be expanded.

  • :include_config (BOOLEAN) —

    Show config when available (default to false)

Returns:



162
163
164
165
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 162

def get_integrations_action(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_with_http_info(action_id, opts)
  return data
end

#get_integrations_action_draft(action_id, opts = {}) ⇒ Action

Retrieve a Draft

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Indicates fields of the response which should be expanded.

  • :include_config (BOOLEAN) —

    Show config when available (default to false)

Returns:



249
250
251
252
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 249

def get_integrations_action_draft(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_with_http_info(action_id, opts)
  return data
end

#get_integrations_action_draft_schema(action_id, file_name, opts = {}) ⇒ JsonSchemaDocument

Retrieve schema for a Draft based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of schema file to be retrieved for this draft.

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

    the optional parameters

Returns:



335
336
337
338
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 335

def get_integrations_action_draft_schema(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts)
  return data
end

#get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts = {}) ⇒ Array<(JsonSchemaDocument, Fixnum, Hash)>

Retrieve schema for a Draft based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of schema file to be retrieved for this draft.

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

    the optional parameters

Returns:

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

    JsonSchemaDocument data, response status code and response headers



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 346

def get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_schema ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_schema" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_schema" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_action_draft_template(action_id, file_name, opts = {}) ⇒ String

Retrieve templates for a Draft based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of template file to be retrieved for this action draft.

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

    the optional parameters

Returns:

  • (String) 


410
411
412
413
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 410

def get_integrations_action_draft_template(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_template_with_http_info(action_id, file_name, opts)
  return data
end

#get_integrations_action_draft_template_with_http_info(action_id, file_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieve templates for a Draft based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of template file to be retrieved for this action draft.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 421

def get_integrations_action_draft_template_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_template ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_template" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_template" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/plain']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_action_draft_validation(action_id, opts = {}) ⇒ DraftValidationResult

Validate current Draft configuration.

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:



484
485
486
487
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 484

def get_integrations_action_draft_validation(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_validation_with_http_info(action_id, opts)
  return data
end

#get_integrations_action_draft_validation_with_http_info(action_id, opts = {}) ⇒ Array<(DraftValidationResult, Fixnum, Hash)>

Validate current Draft configuration.

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:

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

    DraftValidationResult data, response status code and response headers



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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 494

def get_integrations_action_draft_validation_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_validation ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_validation" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/validation".sub('{format}','json').sub('{' + 'actionId' + '}', action_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 => 'DraftValidationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_action_draft_with_http_info(action_id, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Retrieve a Draft

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Indicates fields of the response which should be expanded.

  • :include_config (BOOLEAN) —

    Show config when available

Returns:

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

    Action data, response status code and response headers



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

def get_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of contract'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)

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

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

#get_integrations_action_schema(action_id, file_name, opts = {}) ⇒ JsonSchemaDocument

Retrieve schema for an action based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of schema file to be retrieved for this action.

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

    the optional parameters

Returns:



550
551
552
553
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 550

def get_integrations_action_schema(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_schema_with_http_info(action_id, file_name, opts)
  return data
end

#get_integrations_action_schema_with_http_info(action_id, file_name, opts = {}) ⇒ Array<(JsonSchemaDocument, Fixnum, Hash)>

Retrieve schema for an action based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of schema file to be retrieved for this action.

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

    the optional parameters

Returns:

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

    JsonSchemaDocument data, response status code and response headers



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
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
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 561

def get_integrations_action_schema_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_schema ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_schema" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_schema" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_action_template(action_id, file_name, opts = {}) ⇒ String

Retrieve text of templates for an action based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of template file to be retrieved for this action.

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

    the optional parameters

Returns:

  • (String) 


625
626
627
628
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 625

def get_integrations_action_template(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_template_with_http_info(action_id, file_name, opts)
  return data
end

#get_integrations_action_template_with_http_info(action_id, file_name, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieve text of templates for an action based on filename.

Parameters:

  • action_id —

    actionId

  • file_name —

    Name of template file to be retrieved for this action.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
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
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 636

def get_integrations_action_template_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_template ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_template" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_template" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/plain']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_action_with_http_info(action_id, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Retrieves a single Action matching id.

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Indicates fields of the response which should be expanded.

  • :include_config (BOOLEAN) —

    Show config when available

Returns:

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

    Action data, response status code and response headers



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 174

def get_integrations_action_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action" if action_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of contract'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)

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

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

#get_integrations_actions(opts = {}) ⇒ ActionEntityListing

Retrieves all actions associated with filters passed in via query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String) —

    Filter by category name

  • :secure (String) —

    Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



706
707
708
709
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 706

def get_integrations_actions(opts = {})
  data, _status_code, _headers = get_integrations_actions_with_http_info(opts)
  return data
end

#get_integrations_actions_categories(opts = {}) ⇒ CategoryEntityListing

Retrieves all categories of available Actions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :secure (String) —

    Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



836
837
838
839
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 836

def get_integrations_actions_categories(opts = {})
  data, _status_code, _headers = get_integrations_actions_categories_with_http_info(opts)
  return data
end

#get_integrations_actions_categories_with_http_info(opts = {}) ⇒ Array<(CategoryEntityListing, Fixnum, Hash)>

Retrieves all categories of available Actions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :secure (String) —

    Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    CategoryEntityListing data, response status code and response headers



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

def get_integrations_actions_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_categories ..."
  end
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/categories".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

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

#get_integrations_actions_drafts(opts = {}) ⇒ ActionEntityListing

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String) —

    Filter by category name

  • :secure (String) —

    Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



959
960
961
962
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 959

def get_integrations_actions_drafts(opts = {})
  data, _status_code, _headers = get_integrations_actions_drafts_with_http_info(opts)
  return data
end

#get_integrations_actions_drafts_with_http_info(opts = {}) ⇒ Array<(ActionEntityListing, Fixnum, Hash)>

Retrieves all action drafts associated with the filters passed in via query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String) —

    Filter by category name

  • :secure (String) —

    Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    ActionEntityListing data, response status code and response headers



976
977
978
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
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
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 976

def get_integrations_actions_drafts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_drafts ..."
  end
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/drafts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

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

#get_integrations_actions_with_http_info(opts = {}) ⇒ Array<(ActionEntityListing, Fixnum, Hash)>

Retrieves all actions associated with filters passed in via query param.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category (String) —

    Filter by category name

  • :secure (String) —

    Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :sort_by (String) —

    variable name requested to sort by

  • :expand (Array<Object>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    ActionEntityListing data, response status code and response headers



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

def get_integrations_actions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions ..."
  end
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

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

#patch_integrations_action(action_id, body, opts = {}) ⇒ Action

Patch an Action

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action.

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

    the optional parameters

Returns:



1084
1085
1086
1087
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1084

def patch_integrations_action(action_id, body, opts = {})
  data, _status_code, _headers = patch_integrations_action_with_http_info(action_id, body, opts)
  return data
end

#patch_integrations_action_draft(action_id, body, opts = {}) ⇒ Action

Update an existing Draft

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action Draft.

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

    the optional parameters

Returns:



1159
1160
1161
1162
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1159

def patch_integrations_action_draft(action_id, body, opts = {})
  data, _status_code, _headers = patch_integrations_action_draft_with_http_info(action_id, body, opts)
  return data
end

#patch_integrations_action_draft_with_http_info(action_id, body, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Update an existing Draft

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action Draft.

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1170

def patch_integrations_action_draft_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action_draft" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_integrations_action_with_http_info(action_id, body, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Patch an Action

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action.

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1095

def patch_integrations_action_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_action_draft(action_id, opts = {}) ⇒ Action

Create a new Draft from existing Action

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:



1233
1234
1235
1236
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1233

def post_integrations_action_draft(action_id, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_with_http_info(action_id, opts)
  return data
end

#post_integrations_action_draft_publish(action_id, body, opts = {}) ⇒ Action

Publish a Draft and make it the active Action configuration

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action.

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

    the optional parameters

Returns:



1299
1300
1301
1302
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1299

def post_integrations_action_draft_publish(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_publish_with_http_info(action_id, body, opts)
  return data
end

#post_integrations_action_draft_publish_with_http_info(action_id, body, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Publish a Draft and make it the active Action configuration

Parameters:

  • action_id —

    actionId

  • body —

    Input used to patch the Action.

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1310

def post_integrations_action_draft_publish_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_publish ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_publish" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_publish" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/publish".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_action_draft_test(action_id, body, opts = {}) ⇒ TestExecutionResult

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:



1374
1375
1376
1377
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1374

def post_integrations_action_draft_test(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_test_with_http_info(action_id, body, opts)
  return data
end

#post_integrations_action_draft_test_with_http_info(action_id, body, opts = {}) ⇒ Array<(TestExecutionResult, Fixnum, Hash)>

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:

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

    TestExecutionResult data, response status code and response headers



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1385

def post_integrations_action_draft_test_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_test ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_test" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_test" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'TestExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_action_draft_with_http_info(action_id, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Create a new Draft from existing Action

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1243

def post_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_action_execute(action_id, body, opts = {}) ⇒ Object

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:

  • (Object) 


1449
1450
1451
1452
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1449

def post_integrations_action_execute(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_execute_with_http_info(action_id, body, opts)
  return data
end

#post_integrations_action_execute_with_http_info(action_id, body, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1460

def post_integrations_action_execute_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_execute ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_execute" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_execute" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/execute".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_action_test(action_id, body, opts = {}) ⇒ TestExecutionResult

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:



1524
1525
1526
1527
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1524

def post_integrations_action_test(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_test_with_http_info(action_id, body, opts)
  return data
end

#post_integrations_action_test_with_http_info(action_id, body, opts = {}) ⇒ Array<(TestExecutionResult, Fixnum, Hash)>

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

Parameters:

  • action_id —

    actionId

  • body —

    Map of parameters used for variable substitution.

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

    the optional parameters

Returns:

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

    TestExecutionResult data, response status code and response headers



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1535

def post_integrations_action_test_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_test ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_test" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_test" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'TestExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_actions(body, opts = {}) ⇒ Action

Create a new Action

Parameters:

  • body —

    Input used to create Action.

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

    the optional parameters

Returns:



1598
1599
1600
1601
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1598

def post_integrations_actions(body, opts = {})
  data, _status_code, _headers = post_integrations_actions_with_http_info(body, opts)
  return data
end

#post_integrations_actions_drafts(body, opts = {}) ⇒ Action

Create a new Draft

Parameters:

  • body —

    Input used to create Action Draft.

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

    the optional parameters

Returns:



1663
1664
1665
1666
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1663

def post_integrations_actions_drafts(body, opts = {})
  data, _status_code, _headers = post_integrations_actions_drafts_with_http_info(body, opts)
  return data
end

#post_integrations_actions_drafts_with_http_info(body, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Create a new Draft

Parameters:

  • body —

    Input used to create Action Draft.

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1673

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

#post_integrations_actions_with_http_info(body, opts = {}) ⇒ Array<(Action, Fixnum, Hash)>

Create a new Action

Parameters:

  • body —

    Input used to create Action.

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

    the optional parameters

Returns:

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

    Action data, response status code and response headers



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1608

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