Class: PureCloud::ArchitectApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArchitectApi

Returns a new instance of ArchitectApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

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


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

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) 


106
107
108
109
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 106

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



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
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 117

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



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

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:



179
180
181
182
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 179

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



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

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


246
247
248
249
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 246

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



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
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 257

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) 


319
320
321
322
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 319

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 329

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:



383
384
385
386
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 383

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



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

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:



456
457
458
459
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 456

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:



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

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



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

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

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consumed resources to show

Returns:



636
637
638
639
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 636

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

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consumed resources to show

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 649

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', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', '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, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, 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 (only versioned object types are valid)

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consuming resources to show

Returns:



737
738
739
740
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 737

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 (only versioned object types are valid)

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

    the optional parameters

Options Hash (opts):

  • :resource_type (Array<String>) —

    Types of consuming resources to show

Returns:



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 749

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', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', '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, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, 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:



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

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:



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
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 848

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:



954
955
956
957
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 954

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



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 970

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', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', '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, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, 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:



1072
1073
1074
1075
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1072

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



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

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:



1138
1139
1140
1141
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1138

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:



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1149

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:



1215
1216
1217
1218
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1215

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:



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1230

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:



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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 473

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_prompt(prompt_id, opts = {}) ⇒ Prompt

Get specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



1319
1320
1321
1322
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1319

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



1385
1386
1387
1388
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1385

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



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1396

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:



1461
1462
1463
1464
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1461

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



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1473

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



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1329

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

Returns:



1546
1547
1548
1549
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1546

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

Returns:

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

    PromptEntityListing data, response status code and response headers



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

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

  # 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_systemprompt(prompt_id, opts = {}) ⇒ SystemPrompt

Get a system prompt

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:



1642
1643
1644
1645
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1642

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



1708
1709
1710
1711
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1708

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



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1719

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:



1786
1787
1788
1789
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1786

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:



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
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1800

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



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1652

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:



1889
1890
1891
1892
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1889

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



1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 1905

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:



2002
2003
2004
2005
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2002

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 ID (generated history)

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

  • :sort_order (String) —

    Sort order (default to desc)

  • :action (Array<String>) —

    Flow actions

Returns:



2081
2082
2083
2084
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2081

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 ID (generated history)

  • 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

  • :action (Array<String>) —

    Flow actions

Returns:

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

    HistoryListing data, response status code and response headers



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
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2097

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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  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) 


2200
2201
2202
2203
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2200

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



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2211

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:



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

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) 


2359
2360
2361
2362
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2359

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



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2371

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



2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2287

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:



2444
2445
2446
2447
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2444

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



2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
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
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2457

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



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2013

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)

Returns:



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

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

Returns:

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

    FlowEntityListing data, response status code and response headers



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
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2571

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

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


2728
2729
2730
2731
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2728

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



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

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



2784
2785
2786
2787
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2784

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



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
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2795

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:



2856
2857
2858
2859
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2856

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



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

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



2920
2921
2922
2923
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2920

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



2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2931

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:



2993
2994
2995
2996
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 2993

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



3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3004

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:



3065
3066
3067
3068
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3065

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:



3128
3129
3130
3131
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3128

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



3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3138

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:



3194
3195
3196
3197
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3194

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



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3204

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:



3260
3261
3262
3263
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3260

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



3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3270

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:



3327
3328
3329
3330
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3327

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



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
3388
3389
3390
3391
3392
3393
3394
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3338

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:



3401
3402
3403
3404
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3401

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



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

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:



3467
3468
3469
3470
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3467

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



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

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



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

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



3534
3535
3536
3537
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3534

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:



3608
3609
3610
3611
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3608

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



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

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



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

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



3691
3692
3693
3694
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3691

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



3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3703

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:



3773
3774
3775
3776
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3773

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



3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
 
# File 'lib/purecloudplatformclientv2/api/architect_api.rb', line 3784

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