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_integration(integration_id, opts = {}) ⇒ Integration

Delete integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Returns:



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

def delete_integration(integration_id, opts = {})
  data, _status_code, _headers = delete_integration_with_http_info(integration_id, opts)
  return data
end

#delete_integration_with_http_info(integration_id, opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Delete integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Returns:

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

    Integration data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 42

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

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

Delete an Action

Parameters:

  • action_id —

    actionId

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

    the optional parameters

Returns:

  • (nil) 


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

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) 


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

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



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

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



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

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 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: IntegrationsApi#delete_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integrations_credential(credential_id, opts = {}) ⇒ nil

Delete a set of credentials

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_integrations_credential(credential_id, opts = {})
  delete_integrations_credential_with_http_info(credential_id, opts)
  return nil
end

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

Delete a set of credentials

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 235

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

#get_integration(integration_id, opts = {}) ⇒ Integration

Get integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



295
296
297
298
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 295

def get_integration(integration_id, opts = {})
  data, _status_code, _headers = get_integration_with_http_info(integration_id, opts)
  return data
end

#get_integration_config_current(integration_id, opts = {}) ⇒ IntegrationConfiguration

Get integration configuration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Returns:



408
409
410
411
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 408

def get_integration_config_current(integration_id, opts = {})
  data, _status_code, _headers = get_integration_config_current_with_http_info(integration_id, opts)
  return data
end

#get_integration_config_current_with_http_info(integration_id, opts = {}) ⇒ Array<(IntegrationConfiguration, Fixnum, Hash)>

Get integration configuration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Returns:

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

    IntegrationConfiguration data, response status code and response headers



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 418

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

#get_integration_with_http_info(integration_id, opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Get integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    Integration data, response status code and response headers



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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 311

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

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  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 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 => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations(opts = {}) ⇒ IntegrationEntityListing

List integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



478
479
480
481
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 478

def get_integrations(opts = {})
  data, _status_code, _headers = get_integrations_with_http_info(opts)
  return data
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 a field in the response which should be expanded.

  • :include_config (BOOLEAN) —

    Return config in response. (default to false)

Returns:



584
585
586
587
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 584

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 a field in the response which should be expanded.

  • :include_config (BOOLEAN) —

    Return config in response. (default to false)

Returns:



671
672
673
674
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 671

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:



757
758
759
760
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 757

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



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

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 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 => '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) 


832
833
834
835
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 832

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



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

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 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 => '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:



906
907
908
909
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 906

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



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

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 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 => '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 a field in the response which should be expanded.

  • :include_config (BOOLEAN) —

    Return config in response.

Returns:

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

    Action data, response status code and response headers



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
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
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 683

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 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 => '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:



972
973
974
975
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 972

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



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

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 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 => '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) 


1047
1048
1049
1050
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1047

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



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1058

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 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 => '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 a field in the response which should be expanded.

  • :include_config (BOOLEAN) —

    Return config in response.

Returns:

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

    Action data, response status code and response headers



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
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 596

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 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 => '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):

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field. (default to asc)

  • :category (String) —

    Filter by category name

  • :name (String) —

    Filter by action name. Provide full or just the first part of 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.

  • :include_auth_actions (String) —

    Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)

Returns:



1130
1131
1132
1133
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1130

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

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field. (default to asc)

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

Returns:



1284
1285
1286
1287
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1284

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

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field.

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

Returns:

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

    CategoryEntityListing data, response status code and response headers



1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
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
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1300

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[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  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[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']

  # 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 => '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):

  • :page_size (Integer) —

    The total page size requested (default to 25)

  • :page_number (Integer) —

    The page number requested (default to 1)

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field. (default to asc)

  • :category (String) —

    Filter by category name

  • :name (String) —

    Filter by action name. Provide full or just the first part of 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.

  • :include_auth_actions (String) —

    Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)

Returns:



1413
1414
1415
1416
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1413

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

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field.

  • :category (String) —

    Filter by category name

  • :name (String) —

    Filter by action name. Provide full or just the first part of 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.

  • :include_auth_actions (String) —

    Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.

Returns:

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

    ActionEntityListing data, response status code and response headers



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
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
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1432

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[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
    fail ArgumentError, 'invalid value for "include_auth_actions", 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[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']

  # 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 => '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):

  • :page_size (Integer) —

    The total page size requested

  • :page_number (Integer) —

    The page number requested

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :sort_by (String) —

    Root level field name to sort on.

  • :sort_order (String) —

    Direction to sort &#39;sortBy&#39; field.

  • :category (String) —

    Filter by category name

  • :name (String) —

    Filter by action name. Provide full or just the first part of 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.

  • :include_auth_actions (String) —

    Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.

Returns:

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

    ActionEntityListing data, response status code and response headers



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
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
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
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
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1149

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[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
    fail ArgumentError, 'invalid value for "include_auth_actions", 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[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']

  # 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 => '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

#get_integrations_clientapps(opts = {}) ⇒ ClientAppEntityListing

List permitted client app integrations for the logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



1566
1567
1568
1569
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1566

def get_integrations_clientapps(opts = {})
  data, _status_code, _headers = get_integrations_clientapps_with_http_info(opts)
  return data
end

#get_integrations_clientapps_with_http_info(opts = {}) ⇒ Array<(ClientAppEntityListing, Fixnum, Hash)>

List permitted client app integrations for the logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    ClientAppEntityListing data, response status code and response headers



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
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
1657
1658
1659
1660
1661
1662
1663
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1581

def get_integrations_clientapps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_clientapps ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/clientapps".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'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 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 => 'ClientAppEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_clientapps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_credential(credential_id, opts = {}) ⇒ Credential

Get a single credential with sensitive fields redacted

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Returns:



1670
1671
1672
1673
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1670

def get_integrations_credential(credential_id, opts = {})
  data, _status_code, _headers = get_integrations_credential_with_http_info(credential_id, opts)
  return data
end

#get_integrations_credential_with_http_info(credential_id, opts = {}) ⇒ Array<(Credential, Fixnum, Hash)>

Get a single credential with sensitive fields redacted

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Returns:

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

    Credential data, response status code and response headers



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
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1680

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

#get_integrations_credentials(opts = {}) ⇒ CredentialInfoListing

List multiple sets of credentials

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



1736
1737
1738
1739
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1736

def get_integrations_credentials(opts = {})
  data, _status_code, _headers = get_integrations_credentials_with_http_info(opts)
  return data
end

#get_integrations_credentials_types(opts = {}) ⇒ CredentialTypeListing

List all credential types

Parameters:

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

    the optional parameters

Returns:



1807
1808
1809
1810
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1807

def get_integrations_credentials_types(opts = {})
  data, _status_code, _headers = get_integrations_credentials_types_with_http_info(opts)
  return data
end

#get_integrations_credentials_types_with_http_info(opts = {}) ⇒ Array<(CredentialTypeListing, Fixnum, Hash)>

List all credential types

Parameters:

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

    the optional parameters

Returns:

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

    CredentialTypeListing data, response status code and response headers



1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1816

def get_integrations_credentials_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_credentials_types ..."
  end
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials/types".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud 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 => 'CredentialTypeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_credentials_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_credentials_with_http_info(opts = {}) ⇒ Array<(CredentialInfoListing, Fixnum, Hash)>

List multiple sets of credentials

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    CredentialInfoListing data, response status code and response headers



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1747

def get_integrations_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_credentials ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials".sub('{format}','json')

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

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

#get_integrations_eventlog(opts = {}) ⇒ IntegrationEventEntityListing

List all events

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)

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :sort_order (String) —

    Order by (default to descending)

  • :entity_id (String) —

    Include only events with this entity ID

Returns:



1867
1868
1869
1870
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1867

def get_integrations_eventlog(opts = {})
  data, _status_code, _headers = get_integrations_eventlog_with_http_info(opts)
  return data
end

#get_integrations_eventlog_event_id(event_id, opts = {}) ⇒ IntegrationEvent

Get a single event

Parameters:

  • event_id —

    Event Id

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

    the optional parameters

Returns:



1963
1964
1965
1966
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1963

def get_integrations_eventlog_event_id(event_id, opts = {})
  data, _status_code, _headers = get_integrations_eventlog_event_id_with_http_info(event_id, opts)
  return data
end

#get_integrations_eventlog_event_id_with_http_info(event_id, opts = {}) ⇒ Array<(IntegrationEvent, Fixnum, Hash)>

Get a single event

Parameters:

  • event_id —

    Event Id

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

    the optional parameters

Returns:

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

    IntegrationEvent data, response status code and response headers



1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1973

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

#get_integrations_eventlog_with_http_info(opts = {}) ⇒ Array<(IntegrationEventEntityListing, Fixnum, Hash)>

List all events

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Order by

  • :entity_id (String) —

    Include only events with this entity ID

Returns:



1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 1881

def get_integrations_eventlog_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_eventlog ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/eventlog".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'entityId'] = opts[:'entity_id'] if opts[:'entity_id']

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

#get_integrations_speech_dialogflow_agent(agent_id, opts = {}) ⇒ DialogflowAgent

Get details about a Dialogflow agent

Parameters:

  • agent_id —

    The agent ID

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

    the optional parameters

Returns:



2028
2029
2030
2031
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2028

def get_integrations_speech_dialogflow_agent(agent_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_dialogflow_agent_with_http_info(agent_id, opts)
  return data
end

#get_integrations_speech_dialogflow_agent_with_http_info(agent_id, opts = {}) ⇒ Array<(DialogflowAgent, Fixnum, Hash)>

Get details about a Dialogflow agent

Parameters:

  • agent_id —

    The agent ID

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

    the optional parameters

Returns:

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

    DialogflowAgent data, response status code and response headers



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2038

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

#get_integrations_speech_dialogflow_agents(opts = {}) ⇒ DialogflowAgentSummaryEntityListing

Get a list of Dialogflow agents in the customers’ Google accounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :name (String) —

    Filter on agent name

Returns:



2095
2096
2097
2098
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2095

def get_integrations_speech_dialogflow_agents(opts = {})
  data, _status_code, _headers = get_integrations_speech_dialogflow_agents_with_http_info(opts)
  return data
end

#get_integrations_speech_dialogflow_agents_with_http_info(opts = {}) ⇒ Array<(DialogflowAgentSummaryEntityListing, Fixnum, Hash)>

Get a list of Dialogflow agents in the customers&#39; Google accounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :name (String) —

    Filter on agent name

Returns:



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2107

def get_integrations_speech_dialogflow_agents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_dialogflow_agents ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/dialogflow/agents".sub('{format}','json')

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

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

#get_integrations_speech_lex_bot_alias(alias_id, opts = {}) ⇒ LexBotAlias

Get details about a Lex bot alias

Parameters:

  • alias_id —

    The alias ID

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

    the optional parameters

Returns:



2175
2176
2177
2178
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2175

def get_integrations_speech_lex_bot_alias(alias_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts)
  return data
end

#get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts = {}) ⇒ Array<(LexBotAlias, Fixnum, Hash)>

Get details about a Lex bot alias

Parameters:

  • alias_id —

    The alias ID

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

    the optional parameters

Returns:

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

    LexBotAlias data, response status code and response headers



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2185

def get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bot_alias ..."
  end
  
  
  # verify the required parameter 'alias_id' is set
  fail ArgumentError, "Missing the required parameter 'alias_id' when calling IntegrationsApi.get_integrations_speech_lex_bot_alias" if alias_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bot/alias/{aliasId}".sub('{format}','json').sub('{' + 'aliasId' + '}', alias_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 => 'LexBotAlias')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_lex_bot_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts = {}) ⇒ LexBotAliasEntityListing

Get a list of aliases for a bot in the customer’s AWS accounts

Parameters:

  • bot_id —

    The bot ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :status (String) —

    Filter on alias status

  • :name (String) —

    Filter on alias name

Returns:



2244
2245
2246
2247
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2244

def get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts)
  return data
end

#get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts = {}) ⇒ Array<(LexBotAliasEntityListing, Fixnum, Hash)>

Get a list of aliases for a bot in the customer&#39;s AWS accounts

Parameters:

  • bot_id —

    The bot ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :status (String) —

    Filter on alias status

  • :name (String) —

    Filter on alias name

Returns:

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

    LexBotAliasEntityListing data, response status code and response headers



2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2258

def get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bot_bot_id_aliases ..."
  end
  
  
  # verify the required parameter 'bot_id' is set
  fail ArgumentError, "Missing the required parameter 'bot_id' when calling IntegrationsApi.get_integrations_speech_lex_bot_bot_id_aliases" if bot_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'status'] && !['READY', 'FAILED', 'BUILDING', 'NOT_BUILT'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of READY, FAILED, BUILDING, NOT_BUILT'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bot/{botId}/aliases".sub('{format}','json').sub('{' + 'botId' + '}', bot_id.to_s)

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

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

#get_integrations_speech_lex_bots(opts = {}) ⇒ LexBotEntityListing

Get a list of Lex bots in the customers’ AWS accounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :name (String) —

    Filter on bot name

Returns:



2347
2348
2349
2350
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2347

def get_integrations_speech_lex_bots(opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bots_with_http_info(opts)
  return data
end

#get_integrations_speech_lex_bots_with_http_info(opts = {}) ⇒ Array<(LexBotEntityListing, Fixnum, Hash)>

Get a list of Lex bots in the customers&#39; AWS accounts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :name (String) —

    Filter on bot name

Returns:

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

    LexBotEntityListing data, response status code and response headers



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2359

def get_integrations_speech_lex_bots_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bots ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bots".sub('{format}','json')

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

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

#get_integrations_speech_tts_engine(engine_id, opts = {}) ⇒ TtsEngineEntity

Get details about a TTS engine

Parameters:

  • engine_id —

    The engine ID

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

    the optional parameters

Options Hash (opts):

  • :include_voices (BOOLEAN) —

    Include voices for the engine (default to false)

Returns:



2428
2429
2430
2431
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2428

def get_integrations_speech_tts_engine(engine_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_with_http_info(engine_id, opts)
  return data
end

#get_integrations_speech_tts_engine_voice(engine_id, voice_id, opts = {}) ⇒ TtsVoiceEntity

Get details about a specific voice for a TTS engine

Parameters:

  • engine_id —

    The engine ID

  • voice_id —

    The voice ID

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

    the optional parameters

Returns:



2502
2503
2504
2505
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2502

def get_integrations_speech_tts_engine_voice(engine_id, voice_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts)
  return data
end

#get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts = {}) ⇒ Array<(TtsVoiceEntity, Fixnum, Hash)>

Get details about a specific voice for a TTS engine

Parameters:

  • engine_id —

    The engine ID

  • voice_id —

    The voice ID

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

    the optional parameters

Returns:

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

    TtsVoiceEntity data, response status code and response headers



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2513

def get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine_voice ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voice" if engine_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'voice_id' is set
  fail ArgumentError, "Missing the required parameter 'voice_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voice" if voice_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s).sub('{' + 'voiceId' + '}', voice_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 => 'TtsVoiceEntity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_engine_voice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_speech_tts_engine_voices(engine_id, opts = {}) ⇒ TtsVoiceEntityListing

Get a list of voices for a TTS engine

Parameters:

  • engine_id —

    The engine ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



2578
2579
2580
2581
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2578

def get_integrations_speech_tts_engine_voices(engine_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts)
  return data
end

#get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts = {}) ⇒ Array<(TtsVoiceEntityListing, Fixnum, Hash)>

Get a list of voices for a TTS engine

Parameters:

  • engine_id —

    The engine ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    TtsVoiceEntityListing data, response status code and response headers



2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2590

def get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine_voices ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voices" if engine_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}/voices".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s)

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

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

#get_integrations_speech_tts_engine_with_http_info(engine_id, opts = {}) ⇒ Array<(TtsEngineEntity, Fixnum, Hash)>

Get details about a TTS engine

Parameters:

  • engine_id —

    The engine ID

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

    the optional parameters

Options Hash (opts):

  • :include_voices (BOOLEAN) —

    Include voices for the engine

Returns:

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

    TtsEngineEntity data, response status code and response headers



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2439

def get_integrations_speech_tts_engine_with_http_info(engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine" if engine_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeVoices'] = opts[:'include_voices'] if opts[:'include_voices']

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

#get_integrations_speech_tts_engines(opts = {}) ⇒ TtsEngineEntityListing

Get a list of TTS engines enabled for org

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :include_voices (BOOLEAN) —

    Include voices for the engine (default to false)

  • :name (String) —

    Filter on engine name

  • :language (String) —

    Filter on supported language. If includeVoices=true then the voices are also filtered.

Returns:



2663
2664
2665
2666
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2663

def get_integrations_speech_tts_engines(opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engines_with_http_info(opts)
  return data
end

#get_integrations_speech_tts_engines_with_http_info(opts = {}) ⇒ Array<(TtsEngineEntityListing, Fixnum, Hash)>

Get a list of TTS engines enabled for org

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :include_voices (BOOLEAN) —

    Include voices for the engine

  • :name (String) —

    Filter on engine name

  • :language (String) —

    Filter on supported language. If includeVoices=true then the voices are also filtered.

Returns:

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

    TtsEngineEntityListing data, response status code and response headers



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2677

def get_integrations_speech_tts_engines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engines ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines".sub('{format}','json')

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

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

#get_integrations_speech_tts_settings(opts = {}) ⇒ TtsSettings

Get TTS settings for an org

Parameters:

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

    the optional parameters

Returns:



2758
2759
2760
2761
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2758

def get_integrations_speech_tts_settings(opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_settings_with_http_info(opts)
  return data
end

#get_integrations_speech_tts_settings_with_http_info(opts = {}) ⇒ Array<(TtsSettings, Fixnum, Hash)>

Get TTS settings for an org

Parameters:

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

    the optional parameters

Returns:

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

    TtsSettings data, response status code and response headers



2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2767

def get_integrations_speech_tts_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud 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 => 'TtsSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_type(type_id, opts = {}) ⇒ IntegrationType

Get integration type.

Parameters:

  • type_id —

    Integration Type Id

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

    the optional parameters

Returns:



2814
2815
2816
2817
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2814

def get_integrations_type(type_id, opts = {})
  data, _status_code, _headers = get_integrations_type_with_http_info(type_id, opts)
  return data
end

#get_integrations_type_configschema(type_id, config_type, opts = {}) ⇒ JsonSchemaDocument

Get properties config schema for an integration type.

Parameters:

  • type_id —

    Integration Type Id

  • config_type —

    Config schema type

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

    the optional parameters

Returns:



2880
2881
2882
2883
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2880

def get_integrations_type_configschema(type_id, config_type, opts = {})
  data, _status_code, _headers = get_integrations_type_configschema_with_http_info(type_id, config_type, opts)
  return data
end

#get_integrations_type_configschema_with_http_info(type_id, config_type, opts = {}) ⇒ Array<(JsonSchemaDocument, Fixnum, Hash)>

Get properties config schema for an integration type.

Parameters:

  • type_id —

    Integration Type Id

  • config_type —

    Config schema type

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

    the optional parameters

Returns:

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

    JsonSchemaDocument data, response status code and response headers



2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2891

def get_integrations_type_configschema_with_http_info(type_id, config_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_type_configschema ..."
  end
  
  
  # verify the required parameter 'type_id' is set
  fail ArgumentError, "Missing the required parameter 'type_id' when calling IntegrationsApi.get_integrations_type_configschema" if type_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'config_type' is set
  fail ArgumentError, "Missing the required parameter 'config_type' when calling IntegrationsApi.get_integrations_type_configschema" if config_type.nil?
  
  # verify enum value
  unless ['properties', 'advanced'].include?(config_type)
    fail ArgumentError, "invalid value for 'config_type', must be one of properties, advanced"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/types/{typeId}/configschemas/{configType}".sub('{format}','json').sub('{' + 'typeId' + '}', type_id.to_s).sub('{' + 'configType' + '}', config_type.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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_type_configschema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_type_with_http_info(type_id, opts = {}) ⇒ Array<(IntegrationType, Fixnum, Hash)>

Get integration type.

Parameters:

  • type_id —

    Integration Type Id

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

    the optional parameters

Returns:

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

    IntegrationType data, response status code and response headers



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2824

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

#get_integrations_types(opts = {}) ⇒ IntegrationTypeEntityListing

List integration types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



2964
2965
2966
2967
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2964

def get_integrations_types(opts = {})
  data, _status_code, _headers = get_integrations_types_with_http_info(opts)
  return data
end

#get_integrations_types_with_http_info(opts = {}) ⇒ Array<(IntegrationTypeEntityListing, Fixnum, Hash)>

List integration types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 2979

def get_integrations_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_types ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/types".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'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 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 => 'IntegrationTypeEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integrations_userapps(opts = {}) ⇒ UserAppEntityListing

List permitted user app integrations for the logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :app_host (String) —

    The type of UserApp to filter by

Returns:



3074
3075
3076
3077
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3074

def get_integrations_userapps(opts = {})
  data, _status_code, _headers = get_integrations_userapps_with_http_info(opts)
  return data
end

#get_integrations_userapps_with_http_info(opts = {}) ⇒ Array<(UserAppEntityListing, Fixnum, Hash)>

List permitted user app integrations for the logged in user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

  • :app_host (String) —

    The type of UserApp to filter by

Returns:

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

    UserAppEntityListing data, response status code and response headers



3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3090

def get_integrations_userapps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_userapps ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/userapps".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'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']
  query_params[:'appHost'] = opts[:'app_host'] if opts[:'app_host']

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

#get_integrations_with_http_info(opts = {}) ⇒ Array<(IntegrationEntityListing, Fixnum, Hash)>

List integrations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    IntegrationEntityListing data, response status code and response headers



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
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
567
568
569
570
571
572
573
574
575
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 493

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

#patch_integration(integration_id, opts = {}) ⇒ Integration

Update an integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

  • :body (Integration) —

    Integration Update

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:



3193
3194
3195
3196
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3193

def patch_integration(integration_id, opts = {})
  data, _status_code, _headers = patch_integration_with_http_info(integration_id, opts)
  return data
end

#patch_integration_with_http_info(integration_id, opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Update an integration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

  • :body (Integration) —

    Integration Update

  • :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<String>) —

    variable name requested by expand list

  • :next_page (String) —

    next page token

  • :previous_page (String) —

    Previous page token

Returns:

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

    Integration data, response status code and response headers



3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3210

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

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  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 = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  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 => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integration\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:



3314
3315
3316
3317
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3314

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:



3389
3390
3391
3392
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3389

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



3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3400

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 OAuth']
  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



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3325

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 OAuth']
  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(opts = {}) ⇒ Integration

Create an integration.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3463
3464
3465
3466
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3463

def post_integrations(opts = {})
  data, _status_code, _headers = post_integrations_with_http_info(opts)
  return data
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:



3526
3527
3528
3529
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3526

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:



3592
3593
3594
3595
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3592

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



3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3603

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 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 => '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:



3667
3668
3669
3670
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3667

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



3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3678

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 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 => '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



3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3536

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 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 => '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) 


3742
3743
3744
3745
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3742

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



3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3753

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 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 => '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:



3817
3818
3819
3820
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3817

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



3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3828

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 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 => '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:



3891
3892
3893
3894
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3891

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:



3956
3957
3958
3959
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3956

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



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3966

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 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 => '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



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3901

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 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 => '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

#post_integrations_credentials(opts = {}) ⇒ CredentialInfo

Create a set of credentials

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4021
4022
4023
4024
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4021

def post_integrations_credentials(opts = {})
  data, _status_code, _headers = post_integrations_credentials_with_http_info(opts)
  return data
end

#post_integrations_credentials_with_http_info(opts = {}) ⇒ Array<(CredentialInfo, Fixnum, Hash)>

Create a set of credentials

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CredentialInfo data, response status code and response headers



4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4031

def post_integrations_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_credentials ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials".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(opts[:'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 => 'CredentialInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_integrations_with_http_info(opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Create an integration.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Integration data, response status code and response headers



3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 3473

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

#post_integrations_workforcemanagement_vendorconnection(opts = {}) ⇒ UserActionCategoryEntityListing

Add a vendor connection

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4084
4085
4086
4087
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4084

def post_integrations_workforcemanagement_vendorconnection(opts = {})
  data, _status_code, _headers = post_integrations_workforcemanagement_vendorconnection_with_http_info(opts)
  return data
end

#post_integrations_workforcemanagement_vendorconnection_with_http_info(opts = {}) ⇒ Array<(UserActionCategoryEntityListing, Fixnum, Hash)>

Add a vendor connection

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4094

def post_integrations_workforcemanagement_vendorconnection_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_workforcemanagement_vendorconnection ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/workforcemanagement/vendorconnection".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(opts[:'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 => 'UserActionCategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_workforcemanagement_vendorconnection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_integration_config_current(integration_id, opts = {}) ⇒ IntegrationConfiguration

Update integration configuration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

Returns:



4148
4149
4150
4151
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4148

def put_integration_config_current(integration_id, opts = {})
  data, _status_code, _headers = put_integration_config_current_with_http_info(integration_id, opts)
  return data
end

#put_integration_config_current_with_http_info(integration_id, opts = {}) ⇒ Array<(IntegrationConfiguration, Fixnum, Hash)>

Update integration configuration.

Parameters:

  • integration_id —

    Integration Id

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IntegrationConfiguration data, response status code and response headers



4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4159

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

#put_integrations_credential(credential_id, opts = {}) ⇒ CredentialInfo

Update a set of credentials

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Options Hash (opts):

Returns:



4221
4222
4223
4224
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4221

def put_integrations_credential(credential_id, opts = {})
  data, _status_code, _headers = put_integrations_credential_with_http_info(credential_id, opts)
  return data
end

#put_integrations_credential_with_http_info(credential_id, opts = {}) ⇒ Array<(CredentialInfo, Fixnum, Hash)>

Update a set of credentials

Parameters:

  • credential_id —

    Credential ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CredentialInfo data, response status code and response headers



4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4232

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

#put_integrations_speech_tts_settings(body, opts = {}) ⇒ TtsSettings

Update TTS settings for an org

Parameters:

  • body —

    Updated TtsSettings

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

    the optional parameters

Returns:



4293
4294
4295
4296
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4293

def put_integrations_speech_tts_settings(body, opts = {})
  data, _status_code, _headers = put_integrations_speech_tts_settings_with_http_info(body, opts)
  return data
end

#put_integrations_speech_tts_settings_with_http_info(body, opts = {}) ⇒ Array<(TtsSettings, Fixnum, Hash)>

Update TTS settings for an org

Parameters:

  • body —

    Updated TtsSettings

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

    the optional parameters

Returns:

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

    TtsSettings data, response status code and response headers



4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/purecloudplatformclientv2/api/integrations_api.rb', line 4303

def put_integrations_speech_tts_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.put_integrations_speech_tts_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.put_integrations_speech_tts_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud 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 => 'TtsSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#put_integrations_speech_tts_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end