purecloudplatformclientv2 91.0.0 → 92.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AmazonLexRequest.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AuditApi.md +70 -0
- data/docs/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/ButtonComponent.md +16 -0
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/EdgeGroup.md +1 -0
- data/docs/EntityListing.md +1 -5
- data/docs/GoogleDialogflowCustomSettings.md +13 -0
- data/docs/LanguageUnderstandingApi.md +164 -30
- data/docs/ListItemComponent.md +19 -0
- data/docs/MessageContent.md +19 -0
- data/docs/NluDomainVersion.md +2 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/SurveyForm.md +0 -2
- data/docs/TextbotsApi.md +78 -0
- data/lib/purecloudplatformclientv2.rb +22 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
- data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
- data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +46 -2
@@ -0,0 +1,413 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require 'date'
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class PostTextResponse
|
21
|
+
# The state of the bot after completion of the request
|
22
|
+
attr_accessor :bot_state
|
23
|
+
|
24
|
+
# The list of messages to respond with, if any
|
25
|
+
attr_accessor :reply_messages
|
26
|
+
|
27
|
+
# The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected.
|
28
|
+
attr_accessor :intent_name
|
29
|
+
|
30
|
+
# Data parameters detected and filled by the bot.
|
31
|
+
attr_accessor :slots
|
32
|
+
|
33
|
+
# The optional ID specified in the request
|
34
|
+
attr_accessor :bot_correlation_id
|
35
|
+
|
36
|
+
# Raw data response from AWS (if called)
|
37
|
+
attr_accessor :amazon_lex
|
38
|
+
|
39
|
+
# Raw data response from Google Dialogflow (if called)
|
40
|
+
attr_accessor :google_dialog_flow
|
41
|
+
|
42
|
+
# Raw data response from Genesys' Dialogengine (if called)
|
43
|
+
attr_accessor :genesys_dialog_engine
|
44
|
+
|
45
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
46
|
+
def self.attribute_map
|
47
|
+
{
|
48
|
+
|
49
|
+
:'bot_state' => :'botState',
|
50
|
+
|
51
|
+
:'reply_messages' => :'replyMessages',
|
52
|
+
|
53
|
+
:'intent_name' => :'intentName',
|
54
|
+
|
55
|
+
:'slots' => :'slots',
|
56
|
+
|
57
|
+
:'bot_correlation_id' => :'botCorrelationId',
|
58
|
+
|
59
|
+
:'amazon_lex' => :'amazonLex',
|
60
|
+
|
61
|
+
:'google_dialog_flow' => :'googleDialogFlow',
|
62
|
+
|
63
|
+
:'genesys_dialog_engine' => :'genesysDialogEngine'
|
64
|
+
|
65
|
+
}
|
66
|
+
end
|
67
|
+
|
68
|
+
# Attribute type mapping.
|
69
|
+
def self.swagger_types
|
70
|
+
{
|
71
|
+
|
72
|
+
:'bot_state' => :'String',
|
73
|
+
|
74
|
+
:'reply_messages' => :'Array<PostTextMessage>',
|
75
|
+
|
76
|
+
:'intent_name' => :'String',
|
77
|
+
|
78
|
+
:'slots' => :'Hash<String, String>',
|
79
|
+
|
80
|
+
:'bot_correlation_id' => :'String',
|
81
|
+
|
82
|
+
:'amazon_lex' => :'Hash<String, Object>',
|
83
|
+
|
84
|
+
:'google_dialog_flow' => :'Hash<String, Object>',
|
85
|
+
|
86
|
+
:'genesys_dialog_engine' => :'Hash<String, Object>'
|
87
|
+
|
88
|
+
}
|
89
|
+
end
|
90
|
+
|
91
|
+
# Initializes the object
|
92
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
93
|
+
def initialize(attributes = {})
|
94
|
+
return unless attributes.is_a?(Hash)
|
95
|
+
|
96
|
+
# convert string to symbol for hash key
|
97
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
98
|
+
|
99
|
+
|
100
|
+
if attributes.has_key?(:'botState')
|
101
|
+
|
102
|
+
|
103
|
+
self.bot_state = attributes[:'botState']
|
104
|
+
|
105
|
+
|
106
|
+
end
|
107
|
+
|
108
|
+
|
109
|
+
if attributes.has_key?(:'replyMessages')
|
110
|
+
|
111
|
+
if (value = attributes[:'replyMessages']).is_a?(Array)
|
112
|
+
self.reply_messages = value
|
113
|
+
end
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
end
|
118
|
+
|
119
|
+
|
120
|
+
if attributes.has_key?(:'intentName')
|
121
|
+
|
122
|
+
|
123
|
+
self.intent_name = attributes[:'intentName']
|
124
|
+
|
125
|
+
|
126
|
+
end
|
127
|
+
|
128
|
+
|
129
|
+
if attributes.has_key?(:'slots')
|
130
|
+
|
131
|
+
if (value = attributes[:'slots']).is_a?(Array)
|
132
|
+
self.slots = value
|
133
|
+
end
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
end
|
138
|
+
|
139
|
+
|
140
|
+
if attributes.has_key?(:'botCorrelationId')
|
141
|
+
|
142
|
+
|
143
|
+
self.bot_correlation_id = attributes[:'botCorrelationId']
|
144
|
+
|
145
|
+
|
146
|
+
end
|
147
|
+
|
148
|
+
|
149
|
+
if attributes.has_key?(:'amazonLex')
|
150
|
+
|
151
|
+
if (value = attributes[:'amazonLex']).is_a?(Array)
|
152
|
+
self.amazon_lex = value
|
153
|
+
end
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
end
|
158
|
+
|
159
|
+
|
160
|
+
if attributes.has_key?(:'googleDialogFlow')
|
161
|
+
|
162
|
+
if (value = attributes[:'googleDialogFlow']).is_a?(Array)
|
163
|
+
self.google_dialog_flow = value
|
164
|
+
end
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
end
|
169
|
+
|
170
|
+
|
171
|
+
if attributes.has_key?(:'genesysDialogEngine')
|
172
|
+
|
173
|
+
if (value = attributes[:'genesysDialogEngine']).is_a?(Array)
|
174
|
+
self.genesys_dialog_engine = value
|
175
|
+
end
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
end
|
180
|
+
|
181
|
+
|
182
|
+
end
|
183
|
+
|
184
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
185
|
+
# @return Array for valid properies with the reasons
|
186
|
+
def list_invalid_properties
|
187
|
+
invalid_properties = Array.new
|
188
|
+
|
189
|
+
|
190
|
+
return invalid_properties
|
191
|
+
end
|
192
|
+
|
193
|
+
# Check to see if the all the properties in the model are valid
|
194
|
+
# @return true if the model is valid
|
195
|
+
def valid?
|
196
|
+
|
197
|
+
|
198
|
+
if @bot_state.nil?
|
199
|
+
return false
|
200
|
+
end
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
allowed_values = ["Complete", "Failed", "MoreData"]
|
205
|
+
if @bot_state && !allowed_values.include?(@bot_state)
|
206
|
+
return false
|
207
|
+
end
|
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
|
+
|
239
|
+
end
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
# Custom attribute writer method checking allowed values (enum).
|
244
|
+
# @param [Object] bot_state Object to be assigned
|
245
|
+
def bot_state=(bot_state)
|
246
|
+
allowed_values = ["Complete", "Failed", "MoreData"]
|
247
|
+
if bot_state && !allowed_values.include?(bot_state)
|
248
|
+
fail ArgumentError, "invalid value for 'bot_state', must be one of #{allowed_values}."
|
249
|
+
end
|
250
|
+
@bot_state = bot_state
|
251
|
+
end
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
# Checks equality by comparing each attribute.
|
292
|
+
# @param [Object] Object to be compared
|
293
|
+
def ==(o)
|
294
|
+
return true if self.equal?(o)
|
295
|
+
self.class == o.class &&
|
296
|
+
bot_state == o.bot_state &&
|
297
|
+
reply_messages == o.reply_messages &&
|
298
|
+
intent_name == o.intent_name &&
|
299
|
+
slots == o.slots &&
|
300
|
+
bot_correlation_id == o.bot_correlation_id &&
|
301
|
+
amazon_lex == o.amazon_lex &&
|
302
|
+
google_dialog_flow == o.google_dialog_flow &&
|
303
|
+
genesys_dialog_engine == o.genesys_dialog_engine
|
304
|
+
end
|
305
|
+
|
306
|
+
# @see the `==` method
|
307
|
+
# @param [Object] Object to be compared
|
308
|
+
def eql?(o)
|
309
|
+
self == o
|
310
|
+
end
|
311
|
+
|
312
|
+
# Calculates hash code according to all attributes.
|
313
|
+
# @return [Fixnum] Hash code
|
314
|
+
def hash
|
315
|
+
[bot_state, reply_messages, intent_name, slots, bot_correlation_id, amazon_lex, google_dialog_flow, genesys_dialog_engine].hash
|
316
|
+
end
|
317
|
+
|
318
|
+
# build the object from hash
|
319
|
+
def build_from_hash(attributes)
|
320
|
+
return nil unless attributes.is_a?(Hash)
|
321
|
+
self.class.swagger_types.each_pair do |key, type|
|
322
|
+
if type =~ /^Array<(.*)>/i
|
323
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
324
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
325
|
+
else
|
326
|
+
#TODO show warning in debug mode
|
327
|
+
end
|
328
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
329
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
330
|
+
else
|
331
|
+
# data not found in attributes(hash), not an issue as the data can be optional
|
332
|
+
end
|
333
|
+
end
|
334
|
+
|
335
|
+
self
|
336
|
+
end
|
337
|
+
|
338
|
+
def _deserialize(type, value)
|
339
|
+
case type.to_sym
|
340
|
+
when :DateTime
|
341
|
+
DateTime.parse(value)
|
342
|
+
when :Date
|
343
|
+
Date.parse(value)
|
344
|
+
when :String
|
345
|
+
value.to_s
|
346
|
+
when :Integer
|
347
|
+
value.to_i
|
348
|
+
when :Float
|
349
|
+
value.to_f
|
350
|
+
when :BOOLEAN
|
351
|
+
if value.to_s =~ /^(true|t|yes|y|1)$/i
|
352
|
+
true
|
353
|
+
else
|
354
|
+
false
|
355
|
+
end
|
356
|
+
when :Object
|
357
|
+
# generic object (usually a Hash), return directly
|
358
|
+
value
|
359
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
360
|
+
inner_type = Regexp.last_match[:inner_type]
|
361
|
+
value.map { |v| _deserialize(inner_type, v) }
|
362
|
+
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
|
363
|
+
k_type = Regexp.last_match[:k_type]
|
364
|
+
v_type = Regexp.last_match[:v_type]
|
365
|
+
{}.tap do |hash|
|
366
|
+
value.each do |k, v|
|
367
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
368
|
+
end
|
369
|
+
end
|
370
|
+
else # model
|
371
|
+
_model = Object.const_get("PureCloud").const_get(type).new
|
372
|
+
_model.build_from_hash(value)
|
373
|
+
end
|
374
|
+
end
|
375
|
+
|
376
|
+
def to_s
|
377
|
+
to_hash.to_s
|
378
|
+
end
|
379
|
+
|
380
|
+
# to_body is an alias to to_body (backward compatibility))
|
381
|
+
def to_body
|
382
|
+
to_hash
|
383
|
+
end
|
384
|
+
|
385
|
+
# return the object in the form of hash
|
386
|
+
def to_hash
|
387
|
+
hash = {}
|
388
|
+
self.class.attribute_map.each_pair do |attr, param|
|
389
|
+
value = self.send(attr)
|
390
|
+
next if value.nil?
|
391
|
+
hash[param] = _to_hash(value)
|
392
|
+
end
|
393
|
+
hash
|
394
|
+
end
|
395
|
+
|
396
|
+
# Method to output non-array value in the form of hash
|
397
|
+
# For object, use to_hash. Otherwise, just return the value
|
398
|
+
def _to_hash(value)
|
399
|
+
if value.is_a?(Array)
|
400
|
+
value.compact.map{ |v| _to_hash(v) }
|
401
|
+
elsif value.is_a?(Hash)
|
402
|
+
{}.tap do |hash|
|
403
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
404
|
+
end
|
405
|
+
elsif value.respond_to? :to_hash
|
406
|
+
value.to_hash
|
407
|
+
else
|
408
|
+
value
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
end
|
413
|
+
end
|
@@ -39,12 +39,6 @@ module PureCloud
|
|
39
39
|
# Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW
|
40
40
|
attr_accessor :language
|
41
41
|
|
42
|
-
# Id of the header image appearing at the top of the form.
|
43
|
-
attr_accessor :header_image_id
|
44
|
-
|
45
|
-
# Temporary URL for accessing header image
|
46
|
-
attr_accessor :header_image_url
|
47
|
-
|
48
42
|
# Markdown text for the top of the form.
|
49
43
|
attr_accessor :header
|
50
44
|
|
@@ -78,10 +72,6 @@ module PureCloud
|
|
78
72
|
|
79
73
|
:'language' => :'language',
|
80
74
|
|
81
|
-
:'header_image_id' => :'headerImageId',
|
82
|
-
|
83
|
-
:'header_image_url' => :'headerImageUrl',
|
84
|
-
|
85
75
|
:'header' => :'header',
|
86
76
|
|
87
77
|
:'footer' => :'footer',
|
@@ -113,10 +103,6 @@ module PureCloud
|
|
113
103
|
|
114
104
|
:'language' => :'String',
|
115
105
|
|
116
|
-
:'header_image_id' => :'String',
|
117
|
-
|
118
|
-
:'header_image_url' => :'String',
|
119
|
-
|
120
106
|
:'header' => :'String',
|
121
107
|
|
122
108
|
:'footer' => :'String',
|
@@ -202,24 +188,6 @@ module PureCloud
|
|
202
188
|
end
|
203
189
|
|
204
190
|
|
205
|
-
if attributes.has_key?(:'headerImageId')
|
206
|
-
|
207
|
-
|
208
|
-
self.header_image_id = attributes[:'headerImageId']
|
209
|
-
|
210
|
-
|
211
|
-
end
|
212
|
-
|
213
|
-
|
214
|
-
if attributes.has_key?(:'headerImageUrl')
|
215
|
-
|
216
|
-
|
217
|
-
self.header_image_url = attributes[:'headerImageUrl']
|
218
|
-
|
219
|
-
|
220
|
-
end
|
221
|
-
|
222
|
-
|
223
191
|
if attributes.has_key?(:'header')
|
224
192
|
|
225
193
|
|
@@ -332,14 +300,6 @@ module PureCloud
|
|
332
300
|
|
333
301
|
|
334
302
|
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
303
|
|
344
304
|
|
345
305
|
if @question_groups.nil?
|
@@ -410,16 +370,6 @@ module PureCloud
|
|
410
370
|
|
411
371
|
|
412
372
|
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
373
|
|
424
374
|
|
425
375
|
|
@@ -443,8 +393,6 @@ module PureCloud
|
|
443
393
|
disabled == o.disabled &&
|
444
394
|
context_id == o.context_id &&
|
445
395
|
language == o.language &&
|
446
|
-
header_image_id == o.header_image_id &&
|
447
|
-
header_image_url == o.header_image_url &&
|
448
396
|
header == o.header &&
|
449
397
|
footer == o.footer &&
|
450
398
|
question_groups == o.question_groups &&
|
@@ -461,7 +409,7 @@ module PureCloud
|
|
461
409
|
# Calculates hash code according to all attributes.
|
462
410
|
# @return [Fixnum] Hash code
|
463
411
|
def hash
|
464
|
-
[id, name, modified_date, published, disabled, context_id, language,
|
412
|
+
[id, name, modified_date, published, disabled, context_id, language, header, footer, question_groups, published_versions, self_uri].hash
|
465
413
|
end
|
466
414
|
|
467
415
|
# build the object from hash
|