Class: PureCloud::ArchitectApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArchitectApi

Returns a new instance of ArchitectApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_architect_emergencygroup(emergency_group_id, opts = {}) ⇒ nil

Deletes a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_architect_emergencygroup(emergency_group_id, opts = {})
  delete_architect_emergencygroup_with_http_info(emergency_group_id, opts)
  return nil
end

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

Deletes a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_architect_ivr(ivr_id, opts = {}) ⇒ nil

Delete an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_architect_ivr(ivr_id, opts = {})
  delete_architect_ivr_with_http_info(ivr_id, opts)
  return nil
end

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

Delete an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 106

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

#delete_architect_prompt(prompt_id, opts = {}) ⇒ nil

Delete specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

  • :all_resources (BOOLEAN) —

    Whether or not to delete all the prompt resources

Returns:

  • (nil) 


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

def delete_architect_prompt(prompt_id, opts = {})
  delete_architect_prompt_with_http_info(prompt_id, opts)
  return nil
end

#delete_architect_prompt_resource(prompt_id, language_code, opts = {}) ⇒ nil

Delete specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

  • (nil) 


234
235
236
237
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 234

def delete_architect_prompt_resource(prompt_id, language_code, opts = {})
  delete_architect_prompt_resource_with_http_info(prompt_id, language_code, opts)
  return nil
end

#delete_architect_prompt_resource_audio(prompt_id, language_code, opts = {}) ⇒ nil

Delete specified user prompt resource audio

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

  • (nil) 


308
309
310
311
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 308

def delete_architect_prompt_resource_audio(prompt_id, language_code, opts = {})
  delete_architect_prompt_resource_audio_with_http_info(prompt_id, language_code, opts)
  return nil
end

#delete_architect_prompt_resource_audio_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete specified user prompt resource audio

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_architect_prompt_resource_audio_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_prompt_resource_audio ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.delete_architect_prompt_resource_audio" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.delete_architect_prompt_resource_audio" if language_code.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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: ArchitectApi#delete_architect_prompt_resource_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_architect_prompt_resource_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 245

def delete_architect_prompt_resource_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_prompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.delete_architect_prompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.delete_architect_prompt_resource" if language_code.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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: ArchitectApi#delete_architect_prompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

  • :all_resources (BOOLEAN) —

    Whether or not to delete all the prompt resources

Returns:

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

    nil, response status code and response headers



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
219
220
221
222
223
224
225
226
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 172

def delete_architect_prompt_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_prompt ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.delete_architect_prompt" if prompt_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'allResources'] = opts[:'all_resources'] if opts[:'all_resources']

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

#delete_architect_prompts(id, opts = {}) ⇒ Operation

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.promptId

Parameters:

  • id —

    List of Prompt IDs

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 381

def delete_architect_prompts(id, opts = {})
  data, _status_code, _headers = delete_architect_prompts_with_http_info(id, opts)
  return data
end

#delete_architect_prompts_with_http_info(id, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Batch-delete a list of prompts Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.promptId

Parameters:

  • id —

    List of Prompt IDs

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

    the optional parameters

Returns:

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

    Operation data, response status code and response headers



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 391

def delete_architect_prompts_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_prompts ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ArchitectApi.delete_architect_prompts" if id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = @api_client.build_collection_param(id, :multi)

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

#delete_architect_schedule(schedule_id, opts = {}) ⇒ nil

Delete a schedule by id

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

  • (nil) 


447
448
449
450
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 447

def delete_architect_schedule(schedule_id, opts = {})
  delete_architect_schedule_with_http_info(schedule_id, opts)
  return nil
end

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

Delete a schedule by id

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 457

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

#delete_architect_schedulegroup(schedule_group_id, opts = {}) ⇒ nil

Deletes a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:

  • (nil) 


511
512
513
514
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 511

def delete_architect_schedulegroup(schedule_group_id, opts = {})
  delete_architect_schedulegroup_with_http_info(schedule_group_id, opts)
  return nil
end

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

Deletes a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_architect_systemprompt_resource(prompt_id, language_code, opts = {}) ⇒ nil

Delete a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

  • (nil) 


576
577
578
579
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 576

def delete_architect_systemprompt_resource(prompt_id, language_code, opts = {})
  delete_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts)
  return nil
end

#delete_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 587

def delete_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_architect_systemprompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.delete_architect_systemprompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.delete_architect_systemprompt_resource" if language_code.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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: ArchitectApi#delete_architect_systemprompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_flow(flow_id, opts = {}) ⇒ nil

Delete flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:

  • (nil) 


649
650
651
652
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 649

def delete_flow(flow_id, opts = {})
  delete_flow_with_http_info(flow_id, opts)
  return nil
end

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

Delete flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_flows(id, opts = {}) ⇒ Operation

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • id —

    List of Flow IDs

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

    the optional parameters

Returns:



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

def delete_flows(id, opts = {})
  data, _status_code, _headers = delete_flows_with_http_info(id, opts)
  return data
end

#delete_flows_datatable(datatable_id, opts = {}) ⇒ nil

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :force (BOOLEAN) —

    force delete, even if in use (default to false)

Returns:

  • (nil) 


780
781
782
783
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 780

def delete_flows_datatable(datatable_id, opts = {})
  delete_flows_datatable_with_http_info(datatable_id, opts)
  return nil
end

#delete_flows_datatable_row(datatable_id, row_id, opts = {}) ⇒ nil

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    the key for the row

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

    the optional parameters

Returns:

  • (nil) 


853
854
855
856
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 853

def delete_flows_datatable_row(datatable_id, row_id, opts = {})
  delete_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
  return nil
end

#delete_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a row entry Deletes a row with a given rowId (the value of the key field).

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    the key for the row

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 864

def delete_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_flows_datatable_row ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.delete_flows_datatable_row" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'row_id' is set
  fail ArgumentError, "Missing the required parameter 'row_id' when calling ArchitectApi.delete_flows_datatable_row" if row_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/rows/{rowId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'rowId' + '}', row_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: ArchitectApi#delete_flows_datatable_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

deletes a specific datatable by id Deletes an entire datatable (including the schema and data) with a given datatableId

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :force (BOOLEAN) —

    force delete, even if in use

Returns:

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

    nil, response status code and response headers



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 791

def delete_flows_datatable_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_flows_datatable ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.delete_flows_datatable" if datatable_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s)

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

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

#delete_flows_with_http_info(id, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Batch-delete a list of flows Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • id —

    List of Flow IDs

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

    the optional parameters

Returns:

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

    Operation data, response status code and response headers



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

def delete_flows_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.delete_flows ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ArchitectApi.delete_flows" if id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = @api_client.build_collection_param(id, :multi)

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

#get_architect_dependencytracking(name, opts = {}) ⇒ DependencyObjectEntityListing

Get Dependency Tracking objects that have a given display name

Parameters:

  • name —

    Object name to search for

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

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :consumed_resources (BOOLEAN) —

    Include resources each result item consumes

  • :consuming_resources (BOOLEAN) —

    Include resources that consume each result item

  • :consumed_resource_type (Array<String>) —

    Types of consumed resources to return, if consumed resources are requested

  • :consuming_resource_type (Array<String>) —

    Types of consuming resources to return, if consuming resources are requested

Returns:



933
934
935
936
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 933

def get_architect_dependencytracking(name, opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_with_http_info(name, opts)
  return data
end

#get_architect_dependencytracking_build(opts = {}) ⇒ DependencyStatus

Get Dependency Tracking build status for an organization

Parameters:

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

    the optional parameters

Returns:



1054
1055
1056
1057
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1054

def get_architect_dependencytracking_build(opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_build_with_http_info(opts)
  return data
end

#get_architect_dependencytracking_build_with_http_info(opts = {}) ⇒ Array<(DependencyStatus, Fixnum, Hash)>

Get Dependency Tracking build status for an organization

Parameters:

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

    the optional parameters

Returns:

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

    DependencyStatus data, response status code and response headers



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

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

#get_architect_dependencytracking_consumedresources(id, version, object_type, opts = {}) ⇒ ConsumedResourcesEntityListing

Get resources that are consumed by a given Dependency Tracking object

Parameters:

  • id —

    Consuming object ID

  • version —

    Consuming object version

  • object_type —

    Consuming object type. Only versioned types are allowed here.

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consumed resources to show

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



1115
1116
1117
1118
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1115

def get_architect_dependencytracking_consumedresources(id, version, object_type, opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_consumedresources_with_http_info(id, version, object_type, opts)
  return data
end

#get_architect_dependencytracking_consumedresources_with_http_info(id, version, object_type, opts = {}) ⇒ Array<(ConsumedResourcesEntityListing, Fixnum, Hash)>

Get resources that are consumed by a given Dependency Tracking object

Parameters:

  • id —

    Consuming object ID

  • version —

    Consuming object version

  • object_type —

    Consuming object type. Only versioned types are allowed here.

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consumed resources to show

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1130

def get_architect_dependencytracking_consumedresources_with_http_info(id, version, object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_consumedresources ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if id.nil?
  
  
  
  
  
  
  # verify the required parameter 'version' is set
  fail ArgumentError, "Missing the required parameter 'version' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if version.nil?
  
  
  
  
  
  
  # verify the required parameter 'object_type' is set
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
  
  # verify enum value
  unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
    fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/consumedresources".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id
  query_params[:'version'] = version
  query_params[:'objectType'] = object_type
  query_params[:'resourceType'] = @api_client.build_collection_param(opts[:'resource_type'], :multi) if opts[:'resource_type']
  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 => 'ConsumedResourcesEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_dependencytracking_consumedresources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_dependencytracking_consumingresources(id, object_type, opts = {}) ⇒ ConsumingResourcesEntityListing

Get resources that consume a given Dependency Tracking object

Parameters:

  • id —

    Consumed object ID

  • object_type —

    Consumed object type

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consuming resources to show. Only versioned types are allowed here.

  • :version (String) —

    Object version

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :flow_filter (String) —

    Show only checkedIn or published flows

Returns:



1236
1237
1238
1239
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1236

def get_architect_dependencytracking_consumingresources(id, object_type, opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts)
  return data
end

#get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts = {}) ⇒ Array<(ConsumingResourcesEntityListing, Fixnum, Hash)>

Get resources that consume a given Dependency Tracking object

Parameters:

  • id —

    Consumed object ID

  • object_type —

    Consumed object type

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consuming resources to show. Only versioned types are allowed here.

  • :version (String) —

    Object version

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :flow_filter (String) —

    Show only checkedIn or published flows

Returns:



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1252

def get_architect_dependencytracking_consumingresources_with_http_info(id, object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_consumingresources ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if id.nil?
  
  
  
  
  
  
  # verify the required parameter 'object_type' is set
  fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
  
  # verify enum value
  unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
    fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'flow_filter'] && !['checkedIn', 'published'].include?(opts[:'flow_filter'])
    fail ArgumentError, 'invalid value for "flow_filter", must be one of checkedIn, published'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/consumingresources".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id
  query_params[:'objectType'] = object_type
  query_params[:'resourceType'] = @api_client.build_collection_param(opts[:'resource_type'], :multi) if opts[:'resource_type']
  query_params[:'version'] = opts[:'version'] if opts[:'version']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'flowFilter'] = opts[:'flow_filter'] if opts[:'flow_filter']

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

#get_architect_dependencytracking_deletedresourceconsumers(opts = {}) ⇒ DependencyObjectEntityListing

Get Dependency Tracking objects that consume deleted resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to search for

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :flow_filter (String) —

    Show only checkedIn or published flows

  • :consumed_resources (BOOLEAN) —

    Return consumed resources? (default to false)

  • :consumed_resource_type (Array<String>) —

    Resource type(s) to return

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



1367
1368
1369
1370
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1367

def get_architect_dependencytracking_deletedresourceconsumers(opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_deletedresourceconsumers_with_http_info(opts)
  return data
end

#get_architect_dependencytracking_deletedresourceconsumers_with_http_info(opts = {}) ⇒ Array<(DependencyObjectEntityListing, Fixnum, Hash)>

Get Dependency Tracking objects that consume deleted resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to search for

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :flow_filter (String) —

    Show only checkedIn or published flows

  • :consumed_resources (BOOLEAN) —

    Return consumed resources?

  • :consumed_resource_type (Array<String>) —

    Resource type(s) to return

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



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

def get_architect_dependencytracking_deletedresourceconsumers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_deletedresourceconsumers ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'flow_filter'] && !['checkedIn', 'published'].include?(opts[:'flow_filter'])
    fail ArgumentError, 'invalid value for "flow_filter", must be one of checkedIn, published'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/deletedresourceconsumers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'objectType'] = @api_client.build_collection_param(opts[:'object_type'], :multi) if opts[:'object_type']
  query_params[:'flowFilter'] = opts[:'flow_filter'] if opts[:'flow_filter']
  query_params[:'consumedResources'] = opts[:'consumed_resources'] if opts[:'consumed_resources']
  query_params[:'consumedResourceType'] = @api_client.build_collection_param(opts[:'consumed_resource_type'], :multi) if opts[:'consumed_resource_type']
  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 => 'DependencyObjectEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_dependencytracking_deletedresourceconsumers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_dependencytracking_object(id, opts = {}) ⇒ DependencyObject

Get a Dependency Tracking object

Parameters:

  • id —

    Object ID

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    Object version

  • :object_type (String) —

    Object type

  • :consumed_resources (BOOLEAN) —

    Include resources this item consumes

  • :consuming_resources (BOOLEAN) —

    Include resources that consume this item

  • :consumed_resource_type (Array<String>) —

    Types of consumed resources to return, if consumed resources are requested

  • :consuming_resource_type (Array<String>) —

    Types of consuming resources to return, if consuming resources are requested

  • :consumed_resource_request (BOOLEAN) —

    Indicate that this is going to look up a consumed resource object

Returns:



1490
1491
1492
1493
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1490

def get_architect_dependencytracking_object(id, opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_object_with_http_info(id, opts)
  return data
end

#get_architect_dependencytracking_object_with_http_info(id, opts = {}) ⇒ Array<(DependencyObject, Fixnum, Hash)>

Get a Dependency Tracking object

Parameters:

  • id —

    Object ID

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    Object version

  • :object_type (String) —

    Object type

  • :consumed_resources (BOOLEAN) —

    Include resources this item consumes

  • :consuming_resources (BOOLEAN) —

    Include resources that consume this item

  • :consumed_resource_type (Array<String>) —

    Types of consumed resources to return, if consumed resources are requested

  • :consuming_resource_type (Array<String>) —

    Types of consuming resources to return, if consuming resources are requested

  • :consumed_resource_request (BOOLEAN) —

    Indicate that this is going to look up a consumed resource object

Returns:

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

    DependencyObject data, response status code and response headers



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
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1507

def get_architect_dependencytracking_object_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_object ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ArchitectApi.get_architect_dependencytracking_object" if id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(opts[:'object_type'])
    fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/object".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id
  query_params[:'version'] = opts[:'version'] if opts[:'version']
  query_params[:'objectType'] = opts[:'object_type'] if opts[:'object_type']
  query_params[:'consumedResources'] = opts[:'consumed_resources'] if opts[:'consumed_resources']
  query_params[:'consumingResources'] = opts[:'consuming_resources'] if opts[:'consuming_resources']
  query_params[:'consumedResourceType'] = @api_client.build_collection_param(opts[:'consumed_resource_type'], :multi) if opts[:'consumed_resource_type']
  query_params[:'consumingResourceType'] = @api_client.build_collection_param(opts[:'consuming_resource_type'], :multi) if opts[:'consuming_resource_type']
  query_params[:'consumedResourceRequest'] = opts[:'consumed_resource_request'] if opts[:'consumed_resource_request']

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

#get_architect_dependencytracking_type(type_id, opts = {}) ⇒ DependencyType

Get a Dependency Tracking type.

Parameters:

  • type_id —

    Type ID

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

    the optional parameters

Returns:



1616
1617
1618
1619
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1616

def get_architect_dependencytracking_type(type_id, opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_type_with_http_info(type_id, opts)
  return data
end

#get_architect_dependencytracking_type_with_http_info(type_id, opts = {}) ⇒ Array<(DependencyType, Fixnum, Hash)>

Get a Dependency Tracking type.

Parameters:

  • type_id —

    Type ID

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

    the optional parameters

Returns:

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

    DependencyType data, response status code and response headers



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
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1626

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

#get_architect_dependencytracking_types(opts = {}) ⇒ DependencyTypeEntityListing

Get Dependency Tracking types.

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:



1682
1683
1684
1685
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1682

def get_architect_dependencytracking_types(opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_types_with_http_info(opts)
  return data
end

#get_architect_dependencytracking_types_with_http_info(opts = {}) ⇒ Array<(DependencyTypeEntityListing, Fixnum, Hash)>

Get Dependency Tracking types.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



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
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1693

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

#get_architect_dependencytracking_updatedresourceconsumers(opts = {}) ⇒ DependencyObjectEntityListing

Get Dependency Tracking objects that depend on updated resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to search for

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :consumed_resources (BOOLEAN) —

    Return consumed resources? (default to false)

  • :consumed_resource_type (Array<String>) —

    Resource type(s) to return

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



1759
1760
1761
1762
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1759

def get_architect_dependencytracking_updatedresourceconsumers(opts = {})
  data, _status_code, _headers = get_architect_dependencytracking_updatedresourceconsumers_with_http_info(opts)
  return data
end

#get_architect_dependencytracking_updatedresourceconsumers_with_http_info(opts = {}) ⇒ Array<(DependencyObjectEntityListing, Fixnum, Hash)>

Get Dependency Tracking objects that depend on updated resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to search for

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :consumed_resources (BOOLEAN) —

    Return consumed resources?

  • :consumed_resource_type (Array<String>) —

    Resource type(s) to return

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



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
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
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/architect_api.rb', line 1774

def get_architect_dependencytracking_updatedresourceconsumers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking_updatedresourceconsumers ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/updatedresourceconsumers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'objectType'] = @api_client.build_collection_param(opts[:'object_type'], :multi) if opts[:'object_type']
  query_params[:'consumedResources'] = opts[:'consumed_resources'] if opts[:'consumed_resources']
  query_params[:'consumedResourceType'] = @api_client.build_collection_param(opts[:'consumed_resource_type'], :multi) if opts[:'consumed_resource_type']
  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 => 'DependencyObjectEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_dependencytracking_updatedresourceconsumers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_dependencytracking_with_http_info(name, opts = {}) ⇒ Array<(DependencyObjectEntityListing, Fixnum, Hash)>

Get Dependency Tracking objects that have a given display name

Parameters:

  • name —

    Object name to search for

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :object_type (Array<String>) —

    Object type(s) to search for

  • :consumed_resources (BOOLEAN) —

    Include resources each result item consumes

  • :consuming_resources (BOOLEAN) —

    Include resources that consume each result item

  • :consumed_resource_type (Array<String>) —

    Types of consumed resources to return, if consumed resources are requested

  • :consuming_resource_type (Array<String>) —

    Types of consuming resources to return, if consuming resources are requested

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 950

def get_architect_dependencytracking_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_dependencytracking ..."
  end
  
  
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling ArchitectApi.get_architect_dependencytracking" if name.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'name'] = name
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'objectType'] = @api_client.build_collection_param(opts[:'object_type'], :multi) if opts[:'object_type']
  query_params[:'consumedResources'] = opts[:'consumed_resources'] if opts[:'consumed_resources']
  query_params[:'consumingResources'] = opts[:'consuming_resources'] if opts[:'consuming_resources']
  query_params[:'consumedResourceType'] = @api_client.build_collection_param(opts[:'consumed_resource_type'], :multi) if opts[:'consumed_resource_type']
  query_params[:'consumingResourceType'] = @api_client.build_collection_param(opts[:'consuming_resource_type'], :multi) if opts[:'consuming_resource_type']

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

#get_architect_emergencygroup(emergency_group_id, opts = {}) ⇒ EmergencyGroup

Gets a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:



1863
1864
1865
1866
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1863

def get_architect_emergencygroup(emergency_group_id, opts = {})
  data, _status_code, _headers = get_architect_emergencygroup_with_http_info(emergency_group_id, opts)
  return data
end

#get_architect_emergencygroup_with_http_info(emergency_group_id, opts = {}) ⇒ Array<(EmergencyGroup, Fixnum, Hash)>

Gets a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:

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

    EmergencyGroup data, response status code and response headers



1873
1874
1875
1876
1877
1878
1879
1880
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1873

def get_architect_emergencygroup_with_http_info(emergency_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_emergencygroup ..."
  end
  
  
  # verify the required parameter 'emergency_group_id' is set
  fail ArgumentError, "Missing the required parameter 'emergency_group_id' when calling ArchitectApi.get_architect_emergencygroup" if emergency_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/emergencygroups/{emergencyGroupId}".sub('{format}','json').sub('{' + 'emergencyGroupId' + '}', emergency_group_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 => 'EmergencyGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_emergencygroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_emergencygroups(opts = {}) ⇒ EmergencyGroupListing

Get a list of emergency groups.

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)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :name (String) —

    Name of the Emergency Group to filter by.

Returns:



1932
1933
1934
1935
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1932

def get_architect_emergencygroups(opts = {})
  data, _status_code, _headers = get_architect_emergencygroups_with_http_info(opts)
  return data
end

#get_architect_emergencygroups_with_http_info(opts = {}) ⇒ Array<(EmergencyGroupListing, Fixnum, Hash)>

Get a list of emergency groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name of the Emergency Group to filter by.

Returns:

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

    EmergencyGroupListing data, response status code and response headers



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
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/architect_api.rb', line 1946

def get_architect_emergencygroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_emergencygroups ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/emergencygroups".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  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 => 'EmergencyGroupListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_emergencygroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_ivr(ivr_id, opts = {}) ⇒ IVR

Get an IVR config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:



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

def get_architect_ivr(ivr_id, opts = {})
  data, _status_code, _headers = get_architect_ivr_with_http_info(ivr_id, opts)
  return data
end

#get_architect_ivr_with_http_info(ivr_id, opts = {}) ⇒ Array<(IVR, Fixnum, Hash)>

Get an IVR config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:

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

    IVR 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/architect_api.rb', line 2038

def get_architect_ivr_with_http_info(ivr_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_ivr ..."
  end
  
  
  # verify the required parameter 'ivr_id' is set
  fail ArgumentError, "Missing the required parameter 'ivr_id' when calling ArchitectApi.get_architect_ivr" if ivr_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/ivrs/{ivrId}".sub('{format}','json').sub('{' + 'ivrId' + '}', ivr_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 => 'IVR')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_ivr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_ivrs(opts = {}) ⇒ IVREntityListing

Get IVR configs.

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)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :name (String) —

    Name of the IVR to filter by.

Returns:



2097
2098
2099
2100
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2097

def get_architect_ivrs(opts = {})
  data, _status_code, _headers = get_architect_ivrs_with_http_info(opts)
  return data
end

#get_architect_ivrs_with_http_info(opts = {}) ⇒ Array<(IVREntityListing, Fixnum, Hash)>

Get IVR configs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name of the IVR to filter by.

Returns:

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

    IVREntityListing data, response status code and response headers



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
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2111

def get_architect_ivrs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_ivrs ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/ivrs".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  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 => 'IVREntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_ivrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_prompt(prompt_id, opts = {}) ⇒ Prompt

Get specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



2193
2194
2195
2196
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2193

def get_architect_prompt(prompt_id, opts = {})
  data, _status_code, _headers = get_architect_prompt_with_http_info(prompt_id, opts)
  return data
end

#get_architect_prompt_history_history_id(prompt_id, history_id, opts = {}) ⇒ HistoryListing

Get generated prompt history

Parameters:

  • prompt_id —

    Prompt ID

  • history_id —

    History request 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)

  • :sort_order (String) —

    Sort order (default to desc)

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:



2264
2265
2266
2267
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2264

def get_architect_prompt_history_history_id(prompt_id, history_id, opts = {})
  data, _status_code, _headers = get_architect_prompt_history_history_id_with_http_info(prompt_id, history_id, opts)
  return data
end

#get_architect_prompt_history_history_id_with_http_info(prompt_id, history_id, opts = {}) ⇒ Array<(HistoryListing, Fixnum, Hash)>

Get generated prompt history

Parameters:

  • prompt_id —

    Prompt ID

  • history_id —

    History request ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_order (String) —

    Sort order

  • :sort_by (String) —

    Sort by

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:

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

    HistoryListing data, response status code and response headers



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
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2280

def get_architect_prompt_history_history_id_with_http_info(prompt_id, history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_prompt_history_history_id ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_prompt_history_history_id" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'history_id' is set
  fail ArgumentError, "Missing the required parameter 'history_id' when calling ArchitectApi.get_architect_prompt_history_history_id" if history_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/history/{historyId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'historyId' + '}', history_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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']

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

#get_architect_prompt_resource(prompt_id, language_code, opts = {}) ⇒ PromptAsset

Get specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:



2383
2384
2385
2386
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2383

def get_architect_prompt_resource(prompt_id, language_code, opts = {})
  data, _status_code, _headers = get_architect_prompt_resource_with_http_info(prompt_id, language_code, opts)
  return data
end

#get_architect_prompt_resource_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(PromptAsset, Fixnum, Hash)>

Get specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    PromptAsset data, response status code and response headers



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
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2394

def get_architect_prompt_resource_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_prompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_prompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.get_architect_prompt_resource" if language_code.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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 => 'PromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_prompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_prompt_resources(prompt_id, opts = {}) ⇒ PromptAssetEntityListing

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

  • prompt_id —

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



2459
2460
2461
2462
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2459

def get_architect_prompt_resources(prompt_id, opts = {})
  data, _status_code, _headers = get_architect_prompt_resources_with_http_info(prompt_id, opts)
  return data
end

#get_architect_prompt_resources_with_http_info(prompt_id, opts = {}) ⇒ Array<(PromptAssetEntityListing, Fixnum, Hash)>

Get a pageable list of user prompt resources The returned list is pageable, and query parameters can be used for filtering.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    PromptAssetEntityListing data, response status code and response headers



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2471

def get_architect_prompt_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_prompt_resources ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_prompt_resources" if prompt_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'PromptAssetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_prompt_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_prompt_with_http_info(prompt_id, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Get specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:

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

    Prompt data, response status code and response headers



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
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2203

def get_architect_prompt_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_prompt ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_prompt" if prompt_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'Prompt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_prompts(opts = {}) ⇒ PromptEntityListing

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

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 (Array<String>) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

Returns:



2546
2547
2548
2549
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2546

def get_architect_prompts(opts = {})
  data, _status_code, _headers = get_architect_prompts_with_http_info(opts)
  return data
end

#get_architect_prompts_with_http_info(opts = {}) ⇒ Array<(PromptEntityListing, Fixnum, Hash)>

Get a pageable list of user prompts The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :name (Array<String>) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    PromptEntityListing data, response status code and response headers



2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2562

def get_architect_prompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_prompts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts".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'] = @api_client.build_collection_param(opts[:'name'], :multi) if opts[:'name']
  query_params[:'description'] = opts[:'description'] if opts[:'description']
  query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

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

#get_architect_schedule(schedule_id, opts = {}) ⇒ Schedule

Get a schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



2658
2659
2660
2661
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2658

def get_architect_schedule(schedule_id, opts = {})
  data, _status_code, _headers = get_architect_schedule_with_http_info(schedule_id, opts)
  return data
end

#get_architect_schedule_with_http_info(schedule_id, opts = {}) ⇒ Array<(Schedule, Fixnum, Hash)>

Get a schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

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

    Schedule data, response status code and response headers



2668
2669
2670
2671
2672
2673
2674
2675
2676
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2668

def get_architect_schedule_with_http_info(schedule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedule ..."
  end
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling ArchitectApi.get_architect_schedule" if schedule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_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 => 'Schedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_schedulegroup(schedule_group_id, opts = {}) ⇒ ScheduleGroup

Gets a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:



2723
2724
2725
2726
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2723

def get_architect_schedulegroup(schedule_group_id, opts = {})
  data, _status_code, _headers = get_architect_schedulegroup_with_http_info(schedule_group_id, opts)
  return data
end

#get_architect_schedulegroup_with_http_info(schedule_group_id, opts = {}) ⇒ Array<(ScheduleGroup, Fixnum, Hash)>

Gets a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:

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

    ScheduleGroup data, response status code and response headers



2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2733

def get_architect_schedulegroup_with_http_info(schedule_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedulegroup ..."
  end
  
  
  # verify the required parameter 'schedule_group_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_group_id' when calling ArchitectApi.get_architect_schedulegroup" if schedule_group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedulegroups/{scheduleGroupId}".sub('{format}','json').sub('{' + 'scheduleGroupId' + '}', schedule_group_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 => 'ScheduleGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_schedulegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_schedulegroups(opts = {}) ⇒ ScheduleGroupEntityListing

Get a list of schedule groups.

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)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :name (String) —

    Name of the Schedule Group to filter by.

  • :schedule_ids (String) —

    A comma-delimited list of Schedule IDs to filter by.

Returns:



2793
2794
2795
2796
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2793

def get_architect_schedulegroups(opts = {})
  data, _status_code, _headers = get_architect_schedulegroups_with_http_info(opts)
  return data
end

#get_architect_schedulegroups_with_http_info(opts = {}) ⇒ Array<(ScheduleGroupEntityListing, Fixnum, Hash)>

Get a list of schedule groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name of the Schedule Group to filter by.

  • :schedule_ids (String) —

    A comma-delimited list of Schedule IDs to filter by.

Returns:

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

    ScheduleGroupEntityListing data, response status code and response headers



2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
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
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2808

def get_architect_schedulegroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedulegroups ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedulegroups".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'scheduleIds'] = opts[:'schedule_ids'] if opts[:'schedule_ids']

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

#get_architect_schedules(opts = {}) ⇒ ScheduleEntityListing

Get a list of schedules.

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)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to ASC)

  • :name (String) —

    Name of the Schedule to filter by.

Returns:



2901
2902
2903
2904
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2901

def get_architect_schedules(opts = {})
  data, _status_code, _headers = get_architect_schedules_with_http_info(opts)
  return data
end

#get_architect_schedules_with_http_info(opts = {}) ⇒ Array<(ScheduleEntityListing, Fixnum, Hash)>

Get a list of schedules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name of the Schedule to filter by.

Returns:

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

    ScheduleEntityListing data, response status code and response headers



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
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2915

def get_architect_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_schedules ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedules".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  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 => 'ScheduleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_systemprompt(prompt_id, opts = {}) ⇒ SystemPrompt

Get a system prompt

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:



2997
2998
2999
3000
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2997

def get_architect_systemprompt(prompt_id, opts = {})
  data, _status_code, _headers = get_architect_systemprompt_with_http_info(prompt_id, opts)
  return data
end

#get_architect_systemprompt_history_history_id(prompt_id, history_id, opts = {}) ⇒ HistoryListing

Get generated prompt history

Parameters:

  • prompt_id —

    promptId

  • history_id —

    History request 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)

  • :sort_order (String) —

    Sort order (default to desc)

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:



3068
3069
3070
3071
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3068

def get_architect_systemprompt_history_history_id(prompt_id, history_id, opts = {})
  data, _status_code, _headers = get_architect_systemprompt_history_history_id_with_http_info(prompt_id, history_id, opts)
  return data
end

#get_architect_systemprompt_history_history_id_with_http_info(prompt_id, history_id, opts = {}) ⇒ Array<(HistoryListing, Fixnum, Hash)>

Get generated prompt history

Parameters:

  • prompt_id —

    promptId

  • history_id —

    History request ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_order (String) —

    Sort order

  • :sort_by (String) —

    Sort by

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:

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

    HistoryListing data, response status code and response headers



3084
3085
3086
3087
3088
3089
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/architect_api.rb', line 3084

def get_architect_systemprompt_history_history_id_with_http_info(prompt_id, history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_systemprompt_history_history_id ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_systemprompt_history_history_id" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'history_id' is set
  fail ArgumentError, "Missing the required parameter 'history_id' when calling ArchitectApi.get_architect_systemprompt_history_history_id" if history_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/history/{historyId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'historyId' + '}', history_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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']

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

#get_architect_systemprompt_resource(prompt_id, language_code, opts = {}) ⇒ SystemPromptAsset

Get a system prompt resource.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:



3187
3188
3189
3190
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3187

def get_architect_systemprompt_resource(prompt_id, language_code, opts = {})
  data, _status_code, _headers = get_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts)
  return data
end

#get_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(SystemPromptAsset, Fixnum, Hash)>

Get a system prompt resource.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    SystemPromptAsset data, response status code and response headers



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3198

def get_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_systemprompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_systemprompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.get_architect_systemprompt_resource" if language_code.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.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 => 'SystemPromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_systemprompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_systemprompt_resources(prompt_id, opts = {}) ⇒ SystemPromptAssetEntityListing

Get system prompt resources.

Parameters:

  • prompt_id —

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

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

Returns:



3265
3266
3267
3268
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3265

def get_architect_systemprompt_resources(prompt_id, opts = {})
  data, _status_code, _headers = get_architect_systemprompt_resources_with_http_info(prompt_id, opts)
  return data
end

#get_architect_systemprompt_resources_with_http_info(prompt_id, opts = {}) ⇒ Array<(SystemPromptAssetEntityListing, Fixnum, Hash)>

Get system prompt resources.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



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
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3279

def get_architect_systemprompt_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_systemprompt_resources ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_systemprompt_resources" if prompt_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

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

#get_architect_systemprompt_with_http_info(prompt_id, opts = {}) ⇒ Array<(SystemPrompt, Fixnum, Hash)>

Get a system prompt

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:

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

    SystemPrompt data, response status code and response headers



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

def get_architect_systemprompt_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_systemprompt ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.get_architect_systemprompt" if prompt_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'SystemPrompt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_architect_systemprompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_architect_systemprompts(opts = {}) ⇒ SystemPromptEntityListing

Get System Prompts

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)

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

Returns:



3368
3369
3370
3371
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3368

def get_architect_systemprompts(opts = {})
  data, _status_code, _headers = get_architect_systemprompts_with_http_info(opts)
  return data
end

#get_architect_systemprompts_with_http_info(opts = {}) ⇒ Array<(SystemPromptEntityListing, Fixnum, Hash)>

Get System Prompts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

Returns:

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

    SystemPromptEntityListing data, response status code and response headers



3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
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
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3384

def get_architect_systemprompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_architect_systemprompts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'description'] = opts[:'description'] if opts[:'description']
  query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']

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

#get_flow(flow_id, opts = {}) ⇒ Flow

Get flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (BOOLEAN) —

    Include deleted flows (default to false)

Returns:



3481
3482
3483
3484
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3481

def get_flow(flow_id, opts = {})
  data, _status_code, _headers = get_flow_with_http_info(flow_id, opts)
  return data
end

#get_flow_history_history_id(flow_id, history_id, opts = {}) ⇒ HistoryListing

Get generated flow history

Parameters:

  • flow_id —

    Flow ID

  • history_id —

    History request 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)

  • :sort_order (String) —

    Sort order (default to desc)

  • :sort_by (String) —

    Sort by (default to timestamp)

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:



3560
3561
3562
3563
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3560

def get_flow_history_history_id(flow_id, history_id, opts = {})
  data, _status_code, _headers = get_flow_history_history_id_with_http_info(flow_id, history_id, opts)
  return data
end

#get_flow_history_history_id_with_http_info(flow_id, history_id, opts = {}) ⇒ Array<(HistoryListing, Fixnum, Hash)>

Get generated flow history

Parameters:

  • flow_id —

    Flow ID

  • history_id —

    History request ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_order (String) —

    Sort order

  • :sort_by (String) —

    Sort by

  • :action (Array<String>) —

    Flow actions to include (omit to include all)

Returns:

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

    HistoryListing data, response status code and response headers



3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
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
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3576

def get_flow_history_history_id_with_http_info(flow_id, history_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_history_history_id ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_history_history_id" if flow_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'history_id' is set
  fail ArgumentError, "Missing the required parameter 'history_id' when calling ArchitectApi.get_flow_history_history_id" if history_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['action', 'timestamp', 'user'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of action, timestamp, user'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/history/{historyId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'historyId' + '}', history_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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'action'] = @api_client.build_collection_param(opts[:'action'], :multi) if opts[:'action']

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

#get_flow_latestconfiguration(flow_id, opts = {}) ⇒ Object

Get the latest configuration for flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (BOOLEAN) —

    Include deleted flows (default to false)

Returns:

  • (Object) 


3679
3680
3681
3682
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3679

def get_flow_latestconfiguration(flow_id, opts = {})
  data, _status_code, _headers = get_flow_latestconfiguration_with_http_info(flow_id, opts)
  return data
end

#get_flow_latestconfiguration_with_http_info(flow_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get the latest configuration for flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (BOOLEAN) —

    Include deleted flows

Returns:

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

    Object data, response status code and response headers



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
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3690

def get_flow_latestconfiguration_with_http_info(flow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_latestconfiguration ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_latestconfiguration" if flow_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/latestconfiguration".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)

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

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

#get_flow_version(flow_id, version_id, opts = {}) ⇒ FlowVersion

Get flow version

Parameters:

  • flow_id —

    Flow ID

  • version_id —

    Version ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    Include deleted flows

Returns:



3754
3755
3756
3757
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3754

def get_flow_version(flow_id, version_id, opts = {})
  data, _status_code, _headers = get_flow_version_with_http_info(flow_id, version_id, opts)
  return data
end

#get_flow_version_configuration(flow_id, version_id, opts = {}) ⇒ Object

Create flow version configuration

Parameters:

  • flow_id —

    Flow ID

  • version_id —

    Version ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    Include deleted flows

Returns:

  • (Object) 


3838
3839
3840
3841
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3838

def get_flow_version_configuration(flow_id, version_id, opts = {})
  data, _status_code, _headers = get_flow_version_configuration_with_http_info(flow_id, version_id, opts)
  return data
end

#get_flow_version_configuration_with_http_info(flow_id, version_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Create flow version configuration

Parameters:

  • flow_id —

    Flow ID

  • version_id —

    Version ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    Include deleted flows

Returns:

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

    Object data, response status code and response headers



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
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3850

def get_flow_version_configuration_with_http_info(flow_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_version_configuration ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_version_configuration" if flow_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ArchitectApi.get_flow_version_configuration" if version_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/versions/{versionId}/configuration".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

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

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

#get_flow_version_with_http_info(flow_id, version_id, opts = {}) ⇒ Array<(FlowVersion, Fixnum, Hash)>

Get flow version

Parameters:

  • flow_id —

    Flow ID

  • version_id —

    Version ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    Include deleted flows

Returns:

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

    FlowVersion data, response status code and response headers



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
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3766

def get_flow_version_with_http_info(flow_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_version ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_version" if flow_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ArchitectApi.get_flow_version" if version_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/versions/{versionId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

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

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

#get_flow_versions(flow_id, opts = {}) ⇒ FlowVersionEntityListing

Get flow version list

Parameters:

  • flow_id —

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

  • :deleted (BOOLEAN) —

    Include deleted flows

Returns:



3923
3924
3925
3926
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3923

def get_flow_versions(flow_id, opts = {})
  data, _status_code, _headers = get_flow_versions_with_http_info(flow_id, opts)
  return data
end

#get_flow_versions_with_http_info(flow_id, opts = {}) ⇒ Array<(FlowVersionEntityListing, Fixnum, Hash)>

Get flow version list

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :deleted (BOOLEAN) —

    Include deleted flows

Returns:

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

    FlowVersionEntityListing data, response status code and response headers



3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3936

def get_flow_versions_with_http_info(flow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow_versions ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow_versions" if flow_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/versions".sub('{format}','json').sub('{' + 'flowId' + '}', flow_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[:'deleted'] = opts[:'deleted'] if opts[:'deleted']

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

#get_flow_with_http_info(flow_id, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Get flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :deleted (BOOLEAN) —

    Include deleted flows

Returns:

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

    Flow data, response status code and response headers



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
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3492

def get_flow_with_http_info(flow_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flow ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.get_flow" if flow_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)

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

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

#get_flows(opts = {}) ⇒ FlowEntityListing

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (Array<String>) —

    Type

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

  • :publish_version_id (String) —

    Publish version ID

  • :editable_by (String) —

    Editable by

  • :locked_by (String) —

    Locked by

  • :locked_by_client_id (String) —

    Locked by client ID

  • :secure (String) —

    Secure

  • :deleted (BOOLEAN) —

    Include deleted (default to false)

  • :include_schemas (BOOLEAN) —

    Include variable schemas (default to false)

  • :published_after (String) —

    Published after

  • :published_before (String) —

    Published before

  • :division_id (Array<String>) —

    division ID(s)

Returns:



4030
4031
4032
4033
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4030

def get_flows(opts = {})
  data, _status_code, _headers = get_flows_with_http_info(opts)
  return data
end

#get_flows_datatable(datatable_id, opts = {}) ⇒ DataTable

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

Returns:



4243
4244
4245
4246
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4243

def get_flows_datatable(datatable_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_with_http_info(datatable_id, opts)
  return data
end

#get_flows_datatable_export_job(datatable_id, export_job_id, opts = {}) ⇒ DataTableExportJob

Returns the state information about an export job Returns the state information about an export job.

Parameters:

  • datatable_id —

    id of datatable

  • export_job_id —

    id of export job

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

    the optional parameters

Returns:



4321
4322
4323
4324
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4321

def get_flows_datatable_export_job(datatable_id, export_job_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_export_job_with_http_info(datatable_id, export_job_id, opts)
  return data
end

#get_flows_datatable_export_job_with_http_info(datatable_id, export_job_id, opts = {}) ⇒ Array<(DataTableExportJob, Fixnum, Hash)>

Returns the state information about an export job Returns the state information about an export job.

Parameters:

  • datatable_id —

    id of datatable

  • export_job_id —

    id of export job

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

    the optional parameters

Returns:

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

    DataTableExportJob data, response status code and response headers



4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4332

def get_flows_datatable_export_job_with_http_info(datatable_id, export_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_export_job ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_export_job" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'export_job_id' is set
  fail ArgumentError, "Missing the required parameter 'export_job_id' when calling ArchitectApi.get_flows_datatable_export_job" if export_job_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'exportJobId' + '}', export_job_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 => 'DataTableExportJob')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_export_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flows_datatable_import_job(datatable_id, import_job_id, opts = {}) ⇒ DataTableImportJob

Returns the state information about an import job Returns the state information about an import job.

Parameters:

  • datatable_id —

    id of datatable

  • import_job_id —

    id of import job

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

    the optional parameters

Returns:



4396
4397
4398
4399
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4396

def get_flows_datatable_import_job(datatable_id, import_job_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_import_job_with_http_info(datatable_id, import_job_id, opts)
  return data
end

#get_flows_datatable_import_job_with_http_info(datatable_id, import_job_id, opts = {}) ⇒ Array<(DataTableImportJob, Fixnum, Hash)>

Returns the state information about an import job Returns the state information about an import job.

Parameters:

  • datatable_id —

    id of datatable

  • import_job_id —

    id of import job

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

    the optional parameters

Returns:

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

    DataTableImportJob data, response status code and response headers



4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4407

def get_flows_datatable_import_job_with_http_info(datatable_id, import_job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_import_job ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_import_job" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'import_job_id' is set
  fail ArgumentError, "Missing the required parameter 'import_job_id' when calling ArchitectApi.get_flows_datatable_import_job" if import_job_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'importJobId' + '}', import_job_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 => 'DataTableImportJob')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_import_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flows_datatable_import_jobs(datatable_id, opts = {}) ⇒ EntityListing

Get all recent import jobs Get all recent import jobs

Parameters:

  • datatable_id —

    id of datatable

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



4472
4473
4474
4475
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4472

def get_flows_datatable_import_jobs(datatable_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_import_jobs_with_http_info(datatable_id, opts)
  return data
end

#get_flows_datatable_import_jobs_with_http_info(datatable_id, opts = {}) ⇒ Array<(EntityListing, Fixnum, Hash)>

Get all recent import jobs Get all recent import jobs

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

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

    EntityListing data, response status code and response headers



4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4484

def get_flows_datatable_import_jobs_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_import_jobs ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_import_jobs" if datatable_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/import/jobs".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_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 => 'EntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_import_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flows_datatable_row(datatable_id, row_id, opts = {}) ⇒ Hash<String, Object>

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    The key for the row

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

    the optional parameters

Options Hash (opts):

  • :showbrief (BOOLEAN) —

    if true returns just the key field for the row (default to true)

Returns:

  • (Hash<String, Object>) 


4555
4556
4557
4558
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4555

def get_flows_datatable_row(datatable_id, row_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
  return data
end

#get_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Returns a specific row for the datatable Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    The key for the row

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

    the optional parameters

Options Hash (opts):

  • :showbrief (BOOLEAN) —

    if true returns just the key field for the row

Returns:

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

    Hash<String, Object> data, response status code and response headers



4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4567

def get_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_row ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_row" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'row_id' is set
  fail ArgumentError, "Missing the required parameter 'row_id' when calling ArchitectApi.get_flows_datatable_row" if row_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/rows/{rowId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'rowId' + '}', row_id.to_s)

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

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

#get_flows_datatable_rows(datatable_id, opts = {}) ⇒ DataTableRowEntityListing

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

  • datatable_id —

    id of datatable

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

  • :showbrief (BOOLEAN) —

    If true returns just the key value of the row (default to true)

Returns:



4640
4641
4642
4643
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4640

def get_flows_datatable_rows(datatable_id, opts = {})
  data, _status_code, _headers = get_flows_datatable_rows_with_http_info(datatable_id, opts)
  return data
end

#get_flows_datatable_rows_with_http_info(datatable_id, opts = {}) ⇒ Array<(DataTableRowEntityListing, Fixnum, Hash)>

Returns the rows for the datatable with the given id Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :showbrief (BOOLEAN) —

    If true returns just the key value of the row

Returns:

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

    DataTableRowEntityListing data, response status code and response headers



4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4653

def get_flows_datatable_rows_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_rows ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable_rows" if datatable_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/rows".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_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[:'showbrief'] = opts[:'showbrief'] if opts[:'showbrief']

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

#get_flows_datatable_with_http_info(datatable_id, opts = {}) ⇒ Array<(DataTable, Fixnum, Hash)>

Returns a specific datatable by id Given a datatableId returns the datatable object and schema associated with it.

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

Returns:

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

    DataTable data, response status code and response headers



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
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4254

def get_flows_datatable_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.get_flows_datatable" if datatable_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of schema'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s)

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

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

#get_flows_datatables(opts = {}) ⇒ DataTablesDomainEntityListing

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to ascending)

Returns:



4733
4734
4735
4736
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4733

def get_flows_datatables(opts = {})
  data, _status_code, _headers = get_flows_datatables_with_http_info(opts)
  return data
end

#get_flows_datatables_with_http_info(opts = {}) ⇒ Array<(DataTablesDomainEntityListing, Fixnum, Hash)>

Retrieve a list of datatables for the org Returns a metadata list of the datatables associated with this org, including datatableId, name and description.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4747

def get_flows_datatables_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatables ..."
  end
  
  
  
  
  if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of schema'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['id', 'name'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of id, name'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables".sub('{format}','json')

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

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

#get_flows_divisionviews(opts = {}) ⇒ FlowDivisionViewEntityListing

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (Array<String>) —

    Type

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :publish_version_id (String) —

    Publish version ID

  • :published_after (String) —

    Published after

  • :published_before (String) —

    Published before

  • :division_id (Array<String>) —

    division ID(s)

  • :include_schemas (BOOLEAN) —

    Include variable schemas (default to false)

Returns:



4848
4849
4850
4851
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4848

def get_flows_divisionviews(opts = {})
  data, _status_code, _headers = get_flows_divisionviews_with_http_info(opts)
  return data
end

#get_flows_divisionviews_with_http_info(opts = {}) ⇒ Array<(FlowDivisionViewEntityListing, Fixnum, Hash)>

Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (Array<String>) —

    Type

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :publish_version_id (String) —

    Publish version ID

  • :published_after (String) —

    Published after

  • :published_before (String) —

    Published before

  • :division_id (Array<String>) —

    division ID(s)

  • :include_schemas (BOOLEAN) —

    Include variable schemas

Returns:



4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4869

def get_flows_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if opts[:'type']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'publishVersionId'] = opts[:'publish_version_id'] if opts[:'publish_version_id']
  query_params[:'publishedAfter'] = opts[:'published_after'] if opts[:'published_after']
  query_params[:'publishedBefore'] = opts[:'published_before'] if opts[:'published_before']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'includeSchemas'] = opts[:'include_schemas'] if opts[:'include_schemas']

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

#get_flows_execution(flow_execution_id, opts = {}) ⇒ FlowRuntimeExecution

Get a flow execution’s details. Flow execution details are available for several days after the flow is started.

Parameters:

  • flow_execution_id —

    flow execution ID

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

    the optional parameters

Returns:



5000
5001
5002
5003
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5000

def get_flows_execution(flow_execution_id, opts = {})
  data, _status_code, _headers = get_flows_execution_with_http_info(flow_execution_id, opts)
  return data
end

#get_flows_execution_with_http_info(flow_execution_id, opts = {}) ⇒ Array<(FlowRuntimeExecution, Fixnum, Hash)>

Get a flow execution&#39;s details. Flow execution details are available for several days after the flow is started.

Parameters:

  • flow_execution_id —

    flow execution ID

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

    the optional parameters

Returns:

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

    FlowRuntimeExecution data, response status code and response headers



5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5010

def get_flows_execution_with_http_info(flow_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_execution ..."
  end
  
  
  # verify the required parameter 'flow_execution_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_execution_id' when calling ArchitectApi.get_flows_execution" if flow_execution_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/executions/{flowExecutionId}".sub('{format}','json').sub('{' + 'flowExecutionId' + '}', flow_execution_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 => 'FlowRuntimeExecution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flows_outcome(flow_outcome_id, opts = {}) ⇒ FlowOutcome

Get a flow outcome Returns a specified flow outcome

Parameters:

  • flow_outcome_id —

    flow outcome ID

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

    the optional parameters

Returns:



5065
5066
5067
5068
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5065

def get_flows_outcome(flow_outcome_id, opts = {})
  data, _status_code, _headers = get_flows_outcome_with_http_info(flow_outcome_id, opts)
  return data
end

#get_flows_outcome_with_http_info(flow_outcome_id, opts = {}) ⇒ Array<(FlowOutcome, Fixnum, Hash)>

Get a flow outcome Returns a specified flow outcome

Parameters:

  • flow_outcome_id —

    flow outcome ID

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

    the optional parameters

Returns:

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

    FlowOutcome data, response status code and response headers



5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5075

def get_flows_outcome_with_http_info(flow_outcome_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_outcome ..."
  end
  
  
  # verify the required parameter 'flow_outcome_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_outcome_id' when calling ArchitectApi.get_flows_outcome" if flow_outcome_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/outcomes/{flowOutcomeId}".sub('{format}','json').sub('{' + 'flowOutcomeId' + '}', flow_outcome_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 => 'FlowOutcome')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows_outcome\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_flows_outcomes(opts = {}) ⇒ FlowOutcomeListing

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

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)

  • :sort_by (String) —

    Sort by (default to id)

  • :sort_order (String) —

    Sort order (default to asc)

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

Returns:



5137
5138
5139
5140
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5137

def get_flows_outcomes(opts = {})
  data, _status_code, _headers = get_flows_outcomes_with_http_info(opts)
  return data
end

#get_flows_outcomes_with_http_info(opts = {}) ⇒ Array<(FlowOutcomeListing, Fixnum, Hash)>

Get a pageable list of flow outcomes, filtered by query parameters Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

Returns:

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

    FlowOutcomeListing data, response status code and response headers



5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5154

def get_flows_outcomes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_outcomes ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/outcomes".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'description'] = opts[:'description'] if opts[:'description']
  query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']

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

#get_flows_with_http_info(opts = {}) ⇒ Array<(FlowEntityListing, Fixnum, Hash)>

Get a pageable list of flows, filtered by query parameters If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (Array<String>) —

    Type

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :id (Array<String>) —

    ID

  • :name (String) —

    Name

  • :description (String) —

    Description

  • :name_or_description (String) —

    Name or description

  • :publish_version_id (String) —

    Publish version ID

  • :editable_by (String) —

    Editable by

  • :locked_by (String) —

    Locked by

  • :locked_by_client_id (String) —

    Locked by client ID

  • :secure (String) —

    Secure

  • :deleted (BOOLEAN) —

    Include deleted

  • :include_schemas (BOOLEAN) —

    Include variable schemas

  • :published_after (String) —

    Published after

  • :published_before (String) —

    Published before

  • :division_id (Array<String>) —

    division ID(s)

Returns:

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

    FlowEntityListing data, response status code and response headers



4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
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
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
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
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 4058

def get_flows_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['any', 'checkedin', 'published'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of any, checkedin, published'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if opts[:'type']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'description'] = opts[:'description'] if opts[:'description']
  query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
  query_params[:'publishVersionId'] = opts[:'publish_version_id'] if opts[:'publish_version_id']
  query_params[:'editableBy'] = opts[:'editable_by'] if opts[:'editable_by']
  query_params[:'lockedBy'] = opts[:'locked_by'] if opts[:'locked_by']
  query_params[:'lockedByClientId'] = opts[:'locked_by_client_id'] if opts[:'locked_by_client_id']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
  query_params[:'includeSchemas'] = opts[:'include_schemas'] if opts[:'include_schemas']
  query_params[:'publishedAfter'] = opts[:'published_after'] if opts[:'published_after']
  query_params[:'publishedBefore'] = opts[:'published_before'] if opts[:'published_before']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_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 => 'FlowEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#get_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_architect_dependencytracking_build(opts = {}) ⇒ nil

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


5256
5257
5258
5259
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5256

def post_architect_dependencytracking_build(opts = {})
  post_architect_dependencytracking_build_with_http_info(opts)
  return nil
end

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

Rebuild Dependency Tracking data for an organization Asynchronous. Notification topic: v2.architect.dependencytracking.build

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5265

def post_architect_dependencytracking_build_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_dependencytracking_build ..."
  end
  
  # resource path
  local_var_path = "/api/v2/architect/dependencytracking/build".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(:POST, 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: ArchitectApi#post_architect_dependencytracking_build\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_architect_emergencygroups(body, opts = {}) ⇒ EmergencyGroup

Creates a new emergency group

Parameters:

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

    the optional parameters

Returns:



5311
5312
5313
5314
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5311

def post_architect_emergencygroups(body, opts = {})
  data, _status_code, _headers = post_architect_emergencygroups_with_http_info(body, opts)
  return data
end

#post_architect_emergencygroups_with_http_info(body, opts = {}) ⇒ Array<(EmergencyGroup, Fixnum, Hash)>

Creates a new emergency group

Parameters:

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

    the optional parameters

Returns:

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

    EmergencyGroup data, response status code and response headers



5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5321

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

#post_architect_ivrs(body, opts = {}) ⇒ IVR

Create IVR config.

Parameters:

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

    the optional parameters

Returns:



5376
5377
5378
5379
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5376

def post_architect_ivrs(body, opts = {})
  data, _status_code, _headers = post_architect_ivrs_with_http_info(body, opts)
  return data
end

#post_architect_ivrs_with_http_info(body, opts = {}) ⇒ Array<(IVR, Fixnum, Hash)>

Create IVR config.

Parameters:

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

    the optional parameters

Returns:

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

    IVR data, response status code and response headers



5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5386

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

#post_architect_prompt_history(prompt_id, opts = {}) ⇒ Operation

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.promptId

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



5441
5442
5443
5444
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5441

def post_architect_prompt_history(prompt_id, opts = {})
  data, _status_code, _headers = post_architect_prompt_history_with_http_info(prompt_id, opts)
  return data
end

#post_architect_prompt_history_with_http_info(prompt_id, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Generate prompt history Asynchronous. Notification topic: v2.architect.prompts.promptId

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:

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

    Operation data, response status code and response headers



5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5451

def post_architect_prompt_history_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_prompt_history ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.post_architect_prompt_history" if prompt_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/history".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'Operation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_architect_prompt_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_architect_prompt_resources(prompt_id, body, opts = {}) ⇒ PromptAsset

Create a new user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



5507
5508
5509
5510
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5507

def post_architect_prompt_resources(prompt_id, body, opts = {})
  data, _status_code, _headers = post_architect_prompt_resources_with_http_info(prompt_id, body, opts)
  return data
end

#post_architect_prompt_resources_with_http_info(prompt_id, body, opts = {}) ⇒ Array<(PromptAsset, Fixnum, Hash)>

Create a new user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:

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

    PromptAsset data, response status code and response headers



5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5518

def post_architect_prompt_resources_with_http_info(prompt_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_prompt_resources ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.post_architect_prompt_resources" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.post_architect_prompt_resources" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'PromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_architect_prompt_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_architect_prompts(body, opts = {}) ⇒ Prompt

Create a new user prompt

Parameters:

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

    the optional parameters

Returns:



5581
5582
5583
5584
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5581

def post_architect_prompts(body, opts = {})
  data, _status_code, _headers = post_architect_prompts_with_http_info(body, opts)
  return data
end

#post_architect_prompts_with_http_info(body, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Create a new user prompt

Parameters:

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

    the optional parameters

Returns:

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

    Prompt data, response status code and response headers



5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5591

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

#post_architect_schedulegroups(body, opts = {}) ⇒ ScheduleGroup

Creates a new schedule group

Parameters:

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

    the optional parameters

Returns:



5646
5647
5648
5649
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5646

def post_architect_schedulegroups(body, opts = {})
  data, _status_code, _headers = post_architect_schedulegroups_with_http_info(body, opts)
  return data
end

#post_architect_schedulegroups_with_http_info(body, opts = {}) ⇒ Array<(ScheduleGroup, Fixnum, Hash)>

Creates a new schedule group

Parameters:

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

    the optional parameters

Returns:

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

    ScheduleGroup data, response status code and response headers



5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5656

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

#post_architect_schedules(body, opts = {}) ⇒ Schedule

Create a new schedule.

Parameters:

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

    the optional parameters

Returns:



5711
5712
5713
5714
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5711

def post_architect_schedules(body, opts = {})
  data, _status_code, _headers = post_architect_schedules_with_http_info(body, opts)
  return data
end

#post_architect_schedules_with_http_info(body, opts = {}) ⇒ Array<(Schedule, Fixnum, Hash)>

Create a new schedule.

Parameters:

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

    the optional parameters

Returns:

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

    Schedule data, response status code and response headers



5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5721

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

#post_architect_systemprompt_history(prompt_id, opts = {}) ⇒ Operation

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.systemPromptId

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:



5776
5777
5778
5779
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5776

def post_architect_systemprompt_history(prompt_id, opts = {})
  data, _status_code, _headers = post_architect_systemprompt_history_with_http_info(prompt_id, opts)
  return data
end

#post_architect_systemprompt_history_with_http_info(prompt_id, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Generate system prompt history Asynchronous. Notification topic: v2.architect.systemprompts.systemPromptId

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:

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

    Operation data, response status code and response headers



5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5786

def post_architect_systemprompt_history_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_systemprompt_history ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.post_architect_systemprompt_history" if prompt_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/history".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'Operation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_architect_systemprompt_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_architect_systemprompt_resources(prompt_id, body, opts = {}) ⇒ SystemPromptAsset

Create system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



5842
5843
5844
5845
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5842

def post_architect_systemprompt_resources(prompt_id, body, opts = {})
  data, _status_code, _headers = post_architect_systemprompt_resources_with_http_info(prompt_id, body, opts)
  return data
end

#post_architect_systemprompt_resources_with_http_info(prompt_id, body, opts = {}) ⇒ Array<(SystemPromptAsset, Fixnum, Hash)>

Create system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:

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

    SystemPromptAsset data, response status code and response headers



5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5853

def post_architect_systemprompt_resources_with_http_info(prompt_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_systemprompt_resources ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.post_architect_systemprompt_resources" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.post_architect_systemprompt_resources" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_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 => 'SystemPromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_architect_systemprompt_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flow_versions(flow_id, body, opts = {}) ⇒ FlowVersion

Create flow version

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:



5917
5918
5919
5920
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5917

def post_flow_versions(flow_id, body, opts = {})
  data, _status_code, _headers = post_flow_versions_with_http_info(flow_id, body, opts)
  return data
end

#post_flow_versions_with_http_info(flow_id, body, opts = {}) ⇒ Array<(FlowVersion, Fixnum, Hash)>

Create flow version

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:

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

    FlowVersion data, response status code and response headers



5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5928

def post_flow_versions_with_http_info(flow_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flow_versions ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.post_flow_versions" if flow_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.post_flow_versions" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}/versions".sub('{format}','json').sub('{' + 'flowId' + '}', flow_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 => 'FlowVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_flow_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flows(body, opts = {}) ⇒ Flow

Create flow

Parameters:

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

    the optional parameters

Returns:



5991
5992
5993
5994
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 5991

def post_flows(body, opts = {})
  data, _status_code, _headers = post_flows_with_http_info(body, opts)
  return data
end

#post_flows_actions_checkin(flow, opts = {}) ⇒ Operation

Check-in flow Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



6056
6057
6058
6059
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6056

def post_flows_actions_checkin(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_checkin_with_http_info(flow, opts)
  return data
end

#post_flows_actions_checkin_with_http_info(flow, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Check-in flow Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Operation data, response status code and response headers



6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6066

def post_flows_actions_checkin_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_checkin ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_checkin" if flow.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/checkin".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow

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

#post_flows_actions_checkout(flow, opts = {}) ⇒ Flow

Check-out flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



6122
6123
6124
6125
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6122

def post_flows_actions_checkout(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_checkout_with_http_info(flow, opts)
  return data
end

#post_flows_actions_checkout_with_http_info(flow, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Check-out flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6132

def post_flows_actions_checkout_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_checkout ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_checkout" if flow.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/checkout".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow

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

#post_flows_actions_deactivate(flow, opts = {}) ⇒ Flow

Deactivate flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



6188
6189
6190
6191
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6188

def post_flows_actions_deactivate(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_deactivate_with_http_info(flow, opts)
  return data
end

#post_flows_actions_deactivate_with_http_info(flow, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Deactivate flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6198

def post_flows_actions_deactivate_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_deactivate ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_deactivate" if flow.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/deactivate".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow

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

#post_flows_actions_publish(flow, opts = {}) ⇒ Operation

Publish flow Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    version

Returns:



6255
6256
6257
6258
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6255

def post_flows_actions_publish(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_publish_with_http_info(flow, opts)
  return data
end

#post_flows_actions_publish_with_http_info(flow, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Publish flow Asynchronous. Notification topic: v2.flows.flowId

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    version

Returns:

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

    Operation data, response status code and response headers



6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6266

def post_flows_actions_publish_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_publish ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_publish" if flow.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/publish".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow
  query_params[:'version'] = opts[:'version'] if opts[:'version']

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

#post_flows_actions_revert(flow, opts = {}) ⇒ Flow

Revert flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



6329
6330
6331
6332
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6329

def post_flows_actions_revert(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_revert_with_http_info(flow, opts)
  return data
end

#post_flows_actions_revert_with_http_info(flow, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Revert flow

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6339

def post_flows_actions_revert_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_revert ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_revert" if flow.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/revert".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow

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

#post_flows_actions_unlock(flow, opts = {}) ⇒ Flow

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



6395
6396
6397
6398
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6395

def post_flows_actions_unlock(flow, opts = {})
  data, _status_code, _headers = post_flows_actions_unlock_with_http_info(flow, opts)
  return data
end

#post_flows_actions_unlock_with_http_info(flow, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Unlock flow Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6405

def post_flows_actions_unlock_with_http_info(flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_actions_unlock ..."
  end
  
  
  # verify the required parameter 'flow' is set
  fail ArgumentError, "Missing the required parameter 'flow' when calling ArchitectApi.post_flows_actions_unlock" if flow.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/actions/unlock".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'flow'] = flow

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

#post_flows_datatable_export_jobs(datatable_id, opts = {}) ⇒ DataTableExportJob

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Returns:



6461
6462
6463
6464
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6461

def post_flows_datatable_export_jobs(datatable_id, opts = {})
  data, _status_code, _headers = post_flows_datatable_export_jobs_with_http_info(datatable_id, opts)
  return data
end

#post_flows_datatable_export_jobs_with_http_info(datatable_id, opts = {}) ⇒ Array<(DataTableExportJob, Fixnum, Hash)>

Begin an export process for exporting all rows from a datatable Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Returns:

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

    DataTableExportJob data, response status code and response headers



6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6471

def post_flows_datatable_export_jobs_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_datatable_export_jobs ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.post_flows_datatable_export_jobs" if datatable_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/export/jobs".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_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 => 'DataTableExportJob')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_flows_datatable_export_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flows_datatable_import_jobs(datatable_id, body, opts = {}) ⇒ DataTableImportJob

Begin an import process for importing rows into a datatable Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

  • datatable_id —

    id of datatable

  • body —

    import job information

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

    the optional parameters

Returns:



6527
6528
6529
6530
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6527

def post_flows_datatable_import_jobs(datatable_id, body, opts = {})
  data, _status_code, _headers = post_flows_datatable_import_jobs_with_http_info(datatable_id, body, opts)
  return data
end

#post_flows_datatable_import_jobs_with_http_info(datatable_id, body, opts = {}) ⇒ Array<(DataTableImportJob, Fixnum, Hash)>

Begin an import process for importing rows into a datatable Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response

Parameters:

  • datatable_id —

    id of datatable

  • body —

    import job information

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

    the optional parameters

Returns:

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

    DataTableImportJob data, response status code and response headers



6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6538

def post_flows_datatable_import_jobs_with_http_info(datatable_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_datatable_import_jobs ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.post_flows_datatable_import_jobs" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.post_flows_datatable_import_jobs" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/import/jobs".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_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 => 'DataTableImportJob')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_flows_datatable_import_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flows_datatable_rows(datatable_id, data_table_row, opts = {}) ⇒ Hash<String, Object>

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized’ stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


6602
6603
6604
6605
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6602

def post_flows_datatable_rows(datatable_id, data_table_row, opts = {})
  data, _status_code, _headers = post_flows_datatable_rows_with_http_info(datatable_id, data_table_row, opts)
  return data
end

#post_flows_datatable_rows_with_http_info(datatable_id, data_table_row, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized&#39; stream of key -&gt; value pairs { &quot;Field1&quot;: &quot;XYZZY&quot;, &quot;Field2&quot;: false, &quot;KEY&quot;: &quot;27272&quot; }

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Returns:

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

    Hash<String, Object> data, response status code and response headers



6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6613

def post_flows_datatable_rows_with_http_info(datatable_id, data_table_row, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_datatable_rows ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.post_flows_datatable_rows" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'data_table_row' is set
  fail ArgumentError, "Missing the required parameter 'data_table_row' when calling ArchitectApi.post_flows_datatable_rows" if data_table_row.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/rows".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_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(data_table_row)
  
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#post_flows_datatable_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_flows_datatables(body, opts = {}) ⇒ DataTable

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema’s title field will be overridden by the name field in the DataTable object. See also json-schema.org/

Parameters:

  • body —

    datatable json-schema

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

    the optional parameters

Returns:



6676
6677
6678
6679
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6676

def post_flows_datatables(body, opts = {})
  data, _status_code, _headers = post_flows_datatables_with_http_info(body, opts)
  return data
end

#post_flows_datatables_with_http_info(body, opts = {}) ⇒ Array<(DataTable, Fixnum, Hash)>

Create a new datatable with the specified json-schema definition This will create a new datatable with fields that match the property definitions in the JSON schema. The schema&#39;s title field will be overridden by the name field in the DataTable object. See also json-schema.org/

Parameters:

  • body —

    datatable json-schema

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

    the optional parameters

Returns:

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

    DataTable data, response status code and response headers



6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6686

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

#post_flows_executions(flow_launch_request, opts = {}) ⇒ FlowExecutionLaunchResponse

Launch an instance of a flow definition, for flow types that support it such as the ‘workflow’ type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

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

    the optional parameters

Returns:



6741
6742
6743
6744
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6741

def post_flows_executions(flow_launch_request, opts = {})
  data, _status_code, _headers = post_flows_executions_with_http_info(flow_launch_request, opts)
  return data
end

#post_flows_executions_with_http_info(flow_launch_request, opts = {}) ⇒ Array<(FlowExecutionLaunchResponse, Fixnum, Hash)>

Launch an instance of a flow definition, for flow types that support it such as the &#39;workflow&#39; type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.

Parameters:

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

    the optional parameters

Returns:



6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6751

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

#post_flows_outcomes(opts = {}) ⇒ FlowOutcome

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.flowOutcomeId

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6806
6807
6808
6809
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6806

def post_flows_outcomes(opts = {})
  data, _status_code, _headers = post_flows_outcomes_with_http_info(opts)
  return data
end

#post_flows_outcomes_with_http_info(opts = {}) ⇒ Array<(FlowOutcome, Fixnum, Hash)>

Create a flow outcome Asynchronous. Notification topic: v2.flows.outcomes.flowOutcomeId

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    FlowOutcome data, response status code and response headers



6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6816

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

#post_flows_with_http_info(body, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Create flow

Parameters:

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6001

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

#put_architect_emergencygroup(emergency_group_id, body, opts = {}) ⇒ EmergencyGroup

Updates a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:



6870
6871
6872
6873
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6870

def put_architect_emergencygroup(emergency_group_id, body, opts = {})
  data, _status_code, _headers = put_architect_emergencygroup_with_http_info(emergency_group_id, body, opts)
  return data
end

#put_architect_emergencygroup_with_http_info(emergency_group_id, body, opts = {}) ⇒ Array<(EmergencyGroup, Fixnum, Hash)>

Updates a emergency group by ID

Parameters:

  • emergency_group_id —

    Emergency group ID

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

    the optional parameters

Returns:

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

    EmergencyGroup data, response status code and response headers



6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6881

def put_architect_emergencygroup_with_http_info(emergency_group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_emergencygroup ..."
  end
  
  
  # verify the required parameter 'emergency_group_id' is set
  fail ArgumentError, "Missing the required parameter 'emergency_group_id' when calling ArchitectApi.put_architect_emergencygroup" if emergency_group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_emergencygroup" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/emergencygroups/{emergencyGroupId}".sub('{format}','json').sub('{' + 'emergencyGroupId' + '}', emergency_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmergencyGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_emergencygroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_ivr(ivr_id, body, opts = {}) ⇒ IVR

Update an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:



6945
6946
6947
6948
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6945

def put_architect_ivr(ivr_id, body, opts = {})
  data, _status_code, _headers = put_architect_ivr_with_http_info(ivr_id, body, opts)
  return data
end

#put_architect_ivr_with_http_info(ivr_id, body, opts = {}) ⇒ Array<(IVR, Fixnum, Hash)>

Update an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:

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

    IVR data, response status code and response headers



6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 6956

def put_architect_ivr_with_http_info(ivr_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_ivr ..."
  end
  
  
  # verify the required parameter 'ivr_id' is set
  fail ArgumentError, "Missing the required parameter 'ivr_id' when calling ArchitectApi.put_architect_ivr" if ivr_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_ivr" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/ivrs/{ivrId}".sub('{format}','json').sub('{' + 'ivrId' + '}', ivr_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IVR')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_ivr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_prompt(prompt_id, body, opts = {}) ⇒ Prompt

Update specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



7020
7021
7022
7023
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7020

def put_architect_prompt(prompt_id, body, opts = {})
  data, _status_code, _headers = put_architect_prompt_with_http_info(prompt_id, body, opts)
  return data
end

#put_architect_prompt_resource(prompt_id, language_code, body, opts = {}) ⇒ PromptAsset

Update specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:



7096
7097
7098
7099
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7096

def put_architect_prompt_resource(prompt_id, language_code, body, opts = {})
  data, _status_code, _headers = put_architect_prompt_resource_with_http_info(prompt_id, language_code, body, opts)
  return data
end

#put_architect_prompt_resource_with_http_info(prompt_id, language_code, body, opts = {}) ⇒ Array<(PromptAsset, Fixnum, Hash)>

Update specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    PromptAsset data, response status code and response headers



7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7108

def put_architect_prompt_resource_with_http_info(prompt_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_prompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.put_architect_prompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.put_architect_prompt_resource" if language_code.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_prompt_resource" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_prompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_prompt_with_http_info(prompt_id, body, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Update specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:

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

    Prompt data, response status code and response headers



7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7031

def put_architect_prompt_with_http_info(prompt_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_prompt ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.put_architect_prompt" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_prompt" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Prompt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_schedule(schedule_id, body, opts = {}) ⇒ Schedule

Update schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:



7180
7181
7182
7183
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7180

def put_architect_schedule(schedule_id, body, opts = {})
  data, _status_code, _headers = put_architect_schedule_with_http_info(schedule_id, body, opts)
  return data
end

#put_architect_schedule_with_http_info(schedule_id, body, opts = {}) ⇒ Array<(Schedule, Fixnum, Hash)>

Update schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Returns:

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

    Schedule data, response status code and response headers



7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7191

def put_architect_schedule_with_http_info(schedule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_schedule ..."
  end
  
  
  # verify the required parameter 'schedule_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_id' when calling ArchitectApi.put_architect_schedule" if schedule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_schedule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Schedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_schedulegroup(schedule_group_id, body, opts = {}) ⇒ ScheduleGroup

Updates a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:



7255
7256
7257
7258
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7255

def put_architect_schedulegroup(schedule_group_id, body, opts = {})
  data, _status_code, _headers = put_architect_schedulegroup_with_http_info(schedule_group_id, body, opts)
  return data
end

#put_architect_schedulegroup_with_http_info(schedule_group_id, body, opts = {}) ⇒ Array<(ScheduleGroup, Fixnum, Hash)>

Updates a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Returns:

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

    ScheduleGroup data, response status code and response headers



7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7266

def put_architect_schedulegroup_with_http_info(schedule_group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_schedulegroup ..."
  end
  
  
  # verify the required parameter 'schedule_group_id' is set
  fail ArgumentError, "Missing the required parameter 'schedule_group_id' when calling ArchitectApi.put_architect_schedulegroup" if schedule_group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_schedulegroup" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/schedulegroups/{scheduleGroupId}".sub('{format}','json').sub('{' + 'scheduleGroupId' + '}', schedule_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduleGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_schedulegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_architect_systemprompt_resource(prompt_id, language_code, body, opts = {}) ⇒ SystemPromptAsset

Updates a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:



7331
7332
7333
7334
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7331

def put_architect_systemprompt_resource(prompt_id, language_code, body, opts = {})
  data, _status_code, _headers = put_architect_systemprompt_resource_with_http_info(prompt_id, language_code, body, opts)
  return data
end

#put_architect_systemprompt_resource_with_http_info(prompt_id, language_code, body, opts = {}) ⇒ Array<(SystemPromptAsset, Fixnum, Hash)>

Updates a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

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

    SystemPromptAsset data, response status code and response headers



7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7343

def put_architect_systemprompt_resource_with_http_info(prompt_id, language_code, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_architect_systemprompt_resource ..."
  end
  
  
  # verify the required parameter 'prompt_id' is set
  fail ArgumentError, "Missing the required parameter 'prompt_id' when calling ArchitectApi.put_architect_systemprompt_resource" if prompt_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_code' is set
  fail ArgumentError, "Missing the required parameter 'language_code' when calling ArchitectApi.put_architect_systemprompt_resource" if language_code.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_architect_systemprompt_resource" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'languageCode' + '}', language_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SystemPromptAsset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_architect_systemprompt_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_flow(flow_id, body, opts = {}) ⇒ Flow

Update flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:



7415
7416
7417
7418
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7415

def put_flow(flow_id, body, opts = {})
  data, _status_code, _headers = put_flow_with_http_info(flow_id, body, opts)
  return data
end

#put_flow_with_http_info(flow_id, body, opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Update flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7426

def put_flow_with_http_info(flow_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_flow ..."
  end
  
  
  # verify the required parameter 'flow_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_id' when calling ArchitectApi.put_flow" if flow_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling ArchitectApi.put_flow" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/{flowId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Flow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_flows_datatable(datatable_id, opts = {}) ⇒ DataTable

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

  • :body (DataTable) —

    datatable json-schema

Returns:



7491
7492
7493
7494
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7491

def put_flows_datatable(datatable_id, opts = {})
  data, _status_code, _headers = put_flows_datatable_with_http_info(datatable_id, opts)
  return data
end

#put_flows_datatable_row(datatable_id, row_id, opts = {}) ⇒ Hash<String, Object>

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized’ stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    the key for the row

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

    the optional parameters

Options Hash (opts):

  • :body (Object) —

    datatable row

Returns:

  • (Hash<String, Object>) 


7577
7578
7579
7580
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7577

def put_flows_datatable_row(datatable_id, row_id, opts = {})
  data, _status_code, _headers = put_flows_datatable_row_with_http_info(datatable_id, row_id, opts)
  return data
end

#put_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Update a row entry Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized&#39; stream of key -&gt; value pairs { &quot;Field1&quot;: &quot;XYZZY&quot;, &quot;Field2&quot;: false, &quot;KEY&quot;: &quot;27272&quot; }

Parameters:

  • datatable_id —

    id of datatable

  • row_id —

    the key for the row

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

    the optional parameters

Options Hash (opts):

  • :body (Object) —

    datatable row

Returns:

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

    Hash<String, Object> data, response status code and response headers



7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7589

def put_flows_datatable_row_with_http_info(datatable_id, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_flows_datatable_row ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.put_flows_datatable_row" if datatable_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'row_id' is set
  fail ArgumentError, "Missing the required parameter 'row_id' when calling ArchitectApi.put_flows_datatable_row" if row_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}/rows/{rowId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s).sub('{' + 'rowId' + '}', row_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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_flows_datatable_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_flows_datatable_with_http_info(datatable_id, opts = {}) ⇒ Array<(DataTable, Fixnum, Hash)>

Updates a specific datatable by id Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.

Parameters:

  • datatable_id —

    id of datatable

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

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expand instructions for the result

  • :body (DataTable) —

    datatable json-schema

Returns:

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

    DataTable data, response status code and response headers



7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7503

def put_flows_datatable_with_http_info(datatable_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_flows_datatable ..."
  end
  
  
  # verify the required parameter 'datatable_id' is set
  fail ArgumentError, "Missing the required parameter 'datatable_id' when calling ArchitectApi.put_flows_datatable" if datatable_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of schema'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/datatables/{datatableId}".sub('{format}','json').sub('{' + 'datatableId' + '}', datatable_id.to_s)

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

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

#put_flows_outcome(flow_outcome_id, opts = {}) ⇒ Operation

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.flowoutcomeId

Parameters:

  • flow_outcome_id —

    flow outcome ID

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

    the optional parameters

Options Hash (opts):

Returns:



7659
7660
7661
7662
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7659

def put_flows_outcome(flow_outcome_id, opts = {})
  data, _status_code, _headers = put_flows_outcome_with_http_info(flow_outcome_id, opts)
  return data
end

#put_flows_outcome_with_http_info(flow_outcome_id, opts = {}) ⇒ Array<(Operation, Fixnum, Hash)>

Updates a flow outcome Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.flowoutcomeId

Parameters:

  • flow_outcome_id —

    flow outcome ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Operation data, response status code and response headers



7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 7670

def put_flows_outcome_with_http_info(flow_outcome_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.put_flows_outcome ..."
  end
  
  
  # verify the required parameter 'flow_outcome_id' is set
  fail ArgumentError, "Missing the required parameter 'flow_outcome_id' when calling ArchitectApi.put_flows_outcome" if flow_outcome_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/flows/outcomes/{flowOutcomeId}".sub('{format}','json').sub('{' + 'flowOutcomeId' + '}', flow_outcome_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 => 'Operation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#put_flows_outcome\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end