Class: PureCloud::ArchitectApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/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/purecloudclient_v2a/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/purecloudclient_v2a/api/architect_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

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


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

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



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/purecloudclient_v2a/api/architect_api.rb', line 42

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


97
98
99
100
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 97

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) 


170
171
172
173
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 170

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 181

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



243
244
245
246
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 243

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



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
301
302
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 253

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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) 


309
310
311
312
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 309

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


373
374
375
376
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 373

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


438
439
440
441
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 438

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


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

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



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/purecloudclient_v2a/api/architect_api.rb', line 521

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



575
576
577
578
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 575

def delete_flows(id, opts = {})
  data, _status_code, _headers = delete_flows_with_http_info(id, opts)
  return data
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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



648
649
650
651
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 648

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:



769
770
771
772
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 769

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



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 778

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

Returns:



828
829
830
831
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 828

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

Returns:



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 841

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', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
    fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, 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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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.

Returns:



929
930
931
932
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 929

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.

Returns:



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 941

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', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
    fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
  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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1024
1025
1026
1027
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1024

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:



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1040

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

Returns:



1146
1147
1148
1149
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1146

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

Returns:

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

    DependencyObject data, response status code and response headers



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1162

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', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
    fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, 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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1264
1265
1266
1267
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1264

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1330
1331
1332
1333
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1330

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:



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1341

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1407
1408
1409
1410
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1407

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:



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
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1422

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



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
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 665

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_ivr(ivr_id, opts = {}) ⇒ IVR

Get an IVR config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Returns:



1511
1512
1513
1514
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1511

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1580
1581
1582
1583
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1580

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



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1594

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1676
1677
1678
1679
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1676

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:



1747
1748
1749
1750
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1747

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



1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
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
1857
1858
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1763

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1866
1867
1868
1869
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1866

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



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
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1877

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1942
1943
1944
1945
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1942

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 1686

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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 (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:



2029
2030
2031
2032
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2029

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



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
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2045

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'] = 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[:'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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2141
2142
2143
2144
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2141

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



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
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2151

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2206
2207
2208
2209
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2206

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



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
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2216

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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.

Returns:



2275
2276
2277
2278
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2275

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.

Returns:

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

    ScheduleGroupEntityListing data, response status code and response headers



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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2375
2376
2377
2378
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2375

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



2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
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
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2389

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2471
2472
2473
2474
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2471

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:



2542
2543
2544
2545
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2542

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



2558
2559
2560
2561
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
2652
2653
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2558

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2661
2662
2663
2664
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2661

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



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
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2672

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2739
2740
2741
2742
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2739

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:



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
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2753

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2842
2843
2844
2845
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2842

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



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
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2858

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



2955
2956
2957
2958
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2955

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:



3034
3035
3036
3037
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3034

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



3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3050

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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) 


3153
3154
3155
3156
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3153

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



3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3164

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3228
3229
3230
3231
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3228

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) 


3312
3313
3314
3315
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3312

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



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
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3324

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3240

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3397
3398
3399
3400
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3397

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



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
3474
3475
3476
3477
3478
3479
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3410

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



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
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 2966

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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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(type, opts = {}) ⇒ FlowEntityListing

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

Parameters:

  • type —

    Type

  • 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

  • :publish_version_id (String) —

    Publish version ID

  • :editable_by (String) —

    Editable by

  • :locked_by (String) —

    Locked by

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

Returns:



3502
3503
3504
3505
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3502

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

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

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

Parameters:

  • type —

    Type

  • 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

  • :publish_version_id (String) —

    Publish version ID

  • :editable_by (String) —

    Editable by

  • :locked_by (String) —

    Locked by

  • :secure (String) —

    Secure

  • :deleted (BOOLEAN) —

    Include deleted

  • :include_schemas (BOOLEAN) —

    Include variable schemas

  • :published_after (String) —

    Published after

  • :published_before (String) —

    Published before

Returns:

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

    FlowEntityListing data, response status code and response headers



3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
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
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3528

def get_flows_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows ..."
  end
  
  
  # verify the required parameter 'type' is set
  fail ArgumentError, "Missing the required parameter 'type' when calling ArchitectApi.get_flows" if type.nil?
  
  # verify enum value
  unless ['inboundcall', 'inboundemail', 'inboundshortmessage', 'outboundcall', 'inqueuecall', 'speech', 'securecall', 'surveyinvite', 'workflow'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of inboundcall, inboundemail, inboundshortmessage, outboundcall, inqueuecall, speech, securecall, surveyinvite, workflow"
  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'] = 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[:'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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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) 


3704
3705
3706
3707
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3704

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



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
3746
3747
3748
3749
3750
3751
3752
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3713

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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_ivrs(opts = {}) ⇒ IVR

Create IVR config.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3759
3760
3761
3762
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3759

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

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

Create IVR config.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IVR data, response status code and response headers



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

def post_architect_ivrs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_ivrs ..."
  end
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3822
3823
3824
3825
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3822

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ PromptAsset

Create a new user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:



3888
3889
3890
3891
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3888

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

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

Create a new user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PromptAsset data, response status code and response headers



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

def post_architect_prompt_resources_with_http_info(prompt_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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(opts = {}) ⇒ Prompt

Create a new user prompt

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3960
3961
3962
3963
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 3960

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

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

Create a new user prompt

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Prompt data, response status code and response headers



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

def post_architect_prompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_prompts ..."
  end
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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(opts = {}) ⇒ ScheduleGroup

Creates a new schedule group

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4023
4024
4025
4026
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4023

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

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

Creates a new schedule group

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ScheduleGroup data, response status code and response headers



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

def post_architect_schedulegroups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_schedulegroups ..."
  end
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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(opts = {}) ⇒ Schedule

Create a new schedule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4086
4087
4088
4089
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4086

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

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

Create a new schedule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Schedule data, response status code and response headers



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

def post_architect_schedules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_architect_schedules ..."
  end
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



4149
4150
4151
4152
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4149

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ SystemPromptAsset

Create system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:



4215
4216
4217
4218
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4215

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

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

Create system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SystemPromptAsset data, response status code and response headers



4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4226

def post_architect_systemprompt_resources_with_http_info(prompt_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ FlowVersion

Create flow version

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:



4288
4289
4290
4291
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4288

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

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

Create flow version

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

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

    FlowVersion data, response status code and response headers



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

def post_flow_versions_with_http_info(flow_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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(opts = {}) ⇒ Flow

Create flow

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4360
4361
4362
4363
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4360

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

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

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

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:



4423
4424
4425
4426
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4423

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<(Flow, Fixnum, Hash)>

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

Parameters:

  • flow —

    Flow ID

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

    the optional parameters

Returns:

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

    Flow data, response status code and response headers



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
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4433

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Flow')
  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:



4489
4490
4491
4492
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4489

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



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
4547
4548
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4499

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



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

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



4565
4566
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4565

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



4622
4623
4624
4625
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4622

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



4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4633

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



4696
4697
4698
4699
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4696

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



4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4706

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



4762
4763
4764
4765
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4762

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



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

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 Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_with_http_info(opts = {}) ⇒ Array<(Flow, Fixnum, Hash)>

Create flow

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Flow data, response status code and response headers



4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4370

def post_flows_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows ..."
  end
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_ivr(ivr_id, opts = {}) ⇒ IVR

Update an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Options Hash (opts):

Returns:



4829
4830
4831
4832
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4829

def put_architect_ivr(ivr_id, opts = {})
  data, _status_code, _headers = put_architect_ivr_with_http_info(ivr_id, opts)
  return data
end

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

Update an IVR Config.

Parameters:

  • ivr_id —

    IVR id

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IVR data, response status code and response headers



4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4840

def put_architect_ivr_with_http_info(ivr_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ Prompt

Update specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:



4902
4903
4904
4905
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4902

def put_architect_prompt(prompt_id, opts = {})
  data, _status_code, _headers = put_architect_prompt_with_http_info(prompt_id, opts)
  return data
end

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

Update specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Options Hash (opts):

Returns:



4976
4977
4978
4979
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4976

def put_architect_prompt_resource(prompt_id, language_code, opts = {})
  data, _status_code, _headers = put_architect_prompt_resource_with_http_info(prompt_id, language_code, opts)
  return data
end

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

Update specified user prompt resource

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PromptAsset data, response status code and response headers



4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 4988

def put_architect_prompt_resource_with_http_info(prompt_id, language_code, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Update specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Prompt data, response status code and response headers



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

def put_architect_prompt_with_http_info(prompt_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ Schedule

Update schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

Returns:



5058
5059
5060
5061
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5058

def put_architect_schedule(schedule_id, opts = {})
  data, _status_code, _headers = put_architect_schedule_with_http_info(schedule_id, opts)
  return data
end

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

Update schedule by ID

Parameters:

  • schedule_id —

    Schedule ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Schedule data, response status code and response headers



5069
5070
5071
5072
5073
5074
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/purecloudclient_v2a/api/architect_api.rb', line 5069

def put_architect_schedule_with_http_info(schedule_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ ScheduleGroup

Updates a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Options Hash (opts):

Returns:



5131
5132
5133
5134
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5131

def put_architect_schedulegroup(schedule_group_id, opts = {})
  data, _status_code, _headers = put_architect_schedulegroup_with_http_info(schedule_group_id, opts)
  return data
end

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

Updates a schedule group by ID

Parameters:

  • schedule_group_id —

    Schedule group ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ScheduleGroup data, response status code and response headers



5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5142

def put_architect_schedulegroup_with_http_info(schedule_group_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ SystemPromptAsset

Updates a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Options Hash (opts):

Returns:



5205
5206
5207
5208
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5205

def put_architect_systemprompt_resource(prompt_id, language_code, opts = {})
  data, _status_code, _headers = put_architect_systemprompt_resource_with_http_info(prompt_id, language_code, opts)
  return data
end

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

Updates a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SystemPromptAsset data, response status code and response headers



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
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5217

def put_architect_systemprompt_resource_with_http_info(prompt_id, language_code, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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, opts = {}) ⇒ Flow

Update flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

Returns:



5287
5288
5289
5290
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5287

def put_flow(flow_id, opts = {})
  data, _status_code, _headers = put_flow_with_http_info(flow_id, opts)
  return data
end

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

Update flow

Parameters:

  • flow_id —

    Flow ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Flow data, response status code and response headers



5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
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
 
# File 'lib/purecloudclient_v2a/api/architect_api.rb', line 5298

def put_flow_with_http_info(flow_id, 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?
  
  
  
  
  
  
  
  
  
  
  
  # 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(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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