Class: PureCloud::ArchitectApi

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

def api_client
  @api_client
end

Instance Method Details

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

Batch-delete a list of prompts asynchronously Multiple IDs can be specified, in which case all specified prompts will be deleted.

Parameters:

  • id —

    List of Prompt IDs

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

    the optional parameters

Returns:



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

def delete_prompts(id, opts = {})
  data, status_code, headers = delete_prompts_with_http_info(id, opts)
  return data
end

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


94
95
96
97
 
# File 'lib/purecloud/api/architect_api.rb', line 94

def delete_prompts_prompt_id(prompt_id, opts = {})
  delete_prompts_prompt_id_with_http_info(prompt_id, opts)
  return nil
end

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


156
157
158
159
 
# File 'lib/purecloud/api/architect_api.rb', line 156

def delete_prompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  delete_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return nil
end

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/purecloud/api/architect_api.rb', line 167

def delete_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling delete_prompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling delete_prompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id_resources_languagecode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



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

def delete_prompts_prompt_id_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts_prompt_id ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling delete_prompts_prompt_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Batch-delete a list of prompts asynchronously Multiple IDs can be specified, in which case all specified prompts will be deleted.

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



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

def delete_prompts_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts ..."
  end
  
  # verify the required parameter 'id' is set
  fail "Missing the required parameter 'id' when calling delete_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {}) ⇒ String

Delete a system prompt resource override.

Parameters:

  • prompt_id —

    Prompt ID

  • language_code —

    Language

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

    the optional parameters

Returns:

  • (String) 


220
221
222
223
 
# File 'lib/purecloud/api/architect_api.rb', line 220

def delete_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  data, status_code, headers = delete_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return data
end

#delete_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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

def delete_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#delete_systemprompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling delete_systemprompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling delete_systemprompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ArchitectApi#delete_systemprompts_prompt_id_resources_languagecode\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:



298
299
300
301
 
# File 'lib/purecloud/api/architect_api.rb', line 298

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/purecloud/api/architect_api.rb', line 322

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 "Missing the required parameter 'type' when calling get_flows" if type.nil?
  
  if opts[:'secure'] && !['any', 'checkedin', 'published'].include?(opts[:'secure'])
    fail '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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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

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



395
396
397
398
 
# File 'lib/purecloud/api/architect_api.rb', line 395

def get_prompts(opts = {})
  data, status_code, headers = get_prompts_with_http_info(opts)
  return data
end

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

Get specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Returns:



461
462
463
464
 
# File 'lib/purecloud/api/architect_api.rb', line 461

def get_prompts_prompt_id(prompt_id, opts = {})
  data, status_code, headers = get_prompts_prompt_id_with_http_info(prompt_id, opts)
  return data
end

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



523
524
525
526
 
# File 'lib/purecloud/api/architect_api.rb', line 523

def get_prompts_prompt_id_resources(prompt_id, opts = {})
  data, status_code, headers = get_prompts_prompt_id_resources_with_http_info(prompt_id, opts)
  return data
end

#get_prompts_prompt_id_resources_languagecode(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:



588
589
590
591
 
# File 'lib/purecloud/api/architect_api.rb', line 588

def get_prompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  data, status_code, headers = get_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return data
end

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



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/purecloud/api/architect_api.rb', line 599

def get_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling get_prompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id_resources_languagecode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/purecloud/api/architect_api.rb', line 535

def get_prompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id_resources ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/purecloud/api/architect_api.rb', line 471

def get_prompts_prompt_id_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



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
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/purecloud/api/architect_api.rb', line 409

def get_prompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



658
659
660
661
 
# File 'lib/purecloud/api/architect_api.rb', line 658

def get_systemprompts(opts = {})
  data, status_code, headers = get_systemprompts_with_http_info(opts)
  return data
end

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

Get a system prompt

Parameters:

  • prompt_id —

    promptId

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

    the optional parameters

Returns:



728
729
730
731
 
# File 'lib/purecloud/api/architect_api.rb', line 728

def get_systemprompts_prompt_id(prompt_id, opts = {})
  data, status_code, headers = get_systemprompts_prompt_id_with_http_info(prompt_id, opts)
  return data
end

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

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



792
793
794
795
 
# File 'lib/purecloud/api/architect_api.rb', line 792

def get_systemprompts_prompt_id_resources(prompt_id, opts = {})
  data, status_code, headers = get_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts)
  return data
end

#get_systemprompts_prompt_id_resources_languagecode(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:



861
862
863
864
 
# File 'lib/purecloud/api/architect_api.rb', line 861

def get_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  data, status_code, headers = get_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return data
end

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



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

def get_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling get_systemprompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts_prompt_id_resources_languagecode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/purecloud/api/architect_api.rb', line 806

def get_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id_resources ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/purecloud/api/architect_api.rb', line 738

def get_systemprompts_prompt_id_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



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

def get_systemprompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#get_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_prompts(opts = {}) ⇒ Prompt

Create a new user prompt

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



925
926
927
928
 
# File 'lib/purecloud/api/architect_api.rb', line 925

def post_prompts(opts = {})
  data, status_code, headers = post_prompts_with_http_info(opts)
  return data
end

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



983
984
985
986
 
# File 'lib/purecloud/api/architect_api.rb', line 983

def post_prompts_prompt_id_resources(prompt_id, opts = {})
  data, status_code, headers = post_prompts_prompt_id_resources_with_http_info(prompt_id, opts)
  return data
end

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



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

def post_prompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#post_prompts_prompt_id_resources ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling post_prompts_prompt_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/purecloud/api/architect_api.rb', line 935

def post_prompts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#post_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



1045
1046
1047
1048
 
# File 'lib/purecloud/api/architect_api.rb', line 1045

def post_systemprompts_prompt_id_resources(prompt_id, opts = {})
  data, status_code, headers = post_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts)
  return data
end

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



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/purecloud/api/architect_api.rb', line 1056

def post_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#post_systemprompts_prompt_id_resources ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling post_systemprompts_prompt_id_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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update specified user prompt

Parameters:

  • prompt_id —

    Prompt ID

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

    the optional parameters

Options Hash (opts):

Returns:



1107
1108
1109
1110
 
# File 'lib/purecloud/api/architect_api.rb', line 1107

def put_prompts_prompt_id(prompt_id, opts = {})
  data, status_code, headers = put_prompts_prompt_id_with_http_info(prompt_id, opts)
  return data
end

#put_prompts_prompt_id_resources_languagecode(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:



1170
1171
1172
1173
 
# File 'lib/purecloud/api/architect_api.rb', line 1170

def put_prompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  data, status_code, headers = put_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return data
end

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



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/purecloud/api/architect_api.rb', line 1182

def put_prompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#put_prompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling put_prompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling put_prompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id_resources_languagecode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/purecloud/api/architect_api.rb', line 1118

def put_prompts_prompt_id_with_http_info(prompt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#put_prompts_prompt_id ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling put_prompts_prompt_id" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_systemprompts_prompt_id_resources_languagecode(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:



1237
1238
1239
1240
 
# File 'lib/purecloud/api/architect_api.rb', line 1237

def put_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts = {})
  data, status_code, headers = put_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts)
  return data
end

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



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

def put_systemprompts_prompt_id_resources_languagecode_with_http_info(prompt_id, language_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ArchitectApi#put_systemprompts_prompt_id_resources_languagecode ..."
  end
  
  # verify the required parameter 'prompt_id' is set
  fail "Missing the required parameter 'prompt_id' when calling put_systemprompts_prompt_id_resources_languagecode" if prompt_id.nil?
  
  # verify the required parameter 'language_code' is set
  fail "Missing the required parameter 'language_code' when calling put_systemprompts_prompt_id_resources_languagecode" 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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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_systemprompts_prompt_id_resources_languagecode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end