purecloudplatformclientv2 91.0.0 → 92.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,300 @@
|
|
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
|
+
# Quick reply object
|
21
|
+
class ContentQuickReply
|
22
|
+
# An ID assigned to the quick reply. Each object inside the content array has a unique ID.
|
23
|
+
attr_accessor :id
|
24
|
+
|
25
|
+
# Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply.
|
26
|
+
attr_accessor :text
|
27
|
+
|
28
|
+
# Image associated with quick reply
|
29
|
+
attr_accessor :image
|
30
|
+
|
31
|
+
# Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.
|
32
|
+
attr_accessor :action
|
33
|
+
|
34
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
35
|
+
def self.attribute_map
|
36
|
+
{
|
37
|
+
|
38
|
+
:'id' => :'id',
|
39
|
+
|
40
|
+
:'text' => :'text',
|
41
|
+
|
42
|
+
:'image' => :'image',
|
43
|
+
|
44
|
+
:'action' => :'action'
|
45
|
+
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Attribute type mapping.
|
50
|
+
def self.swagger_types
|
51
|
+
{
|
52
|
+
|
53
|
+
:'id' => :'String',
|
54
|
+
|
55
|
+
:'text' => :'String',
|
56
|
+
|
57
|
+
:'image' => :'String',
|
58
|
+
|
59
|
+
:'action' => :'String'
|
60
|
+
|
61
|
+
}
|
62
|
+
end
|
63
|
+
|
64
|
+
# Initializes the object
|
65
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
66
|
+
def initialize(attributes = {})
|
67
|
+
return unless attributes.is_a?(Hash)
|
68
|
+
|
69
|
+
# convert string to symbol for hash key
|
70
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
71
|
+
|
72
|
+
|
73
|
+
if attributes.has_key?(:'id')
|
74
|
+
|
75
|
+
|
76
|
+
self.id = attributes[:'id']
|
77
|
+
|
78
|
+
|
79
|
+
end
|
80
|
+
|
81
|
+
|
82
|
+
if attributes.has_key?(:'text')
|
83
|
+
|
84
|
+
|
85
|
+
self.text = attributes[:'text']
|
86
|
+
|
87
|
+
|
88
|
+
end
|
89
|
+
|
90
|
+
|
91
|
+
if attributes.has_key?(:'image')
|
92
|
+
|
93
|
+
|
94
|
+
self.image = attributes[:'image']
|
95
|
+
|
96
|
+
|
97
|
+
end
|
98
|
+
|
99
|
+
|
100
|
+
if attributes.has_key?(:'action')
|
101
|
+
|
102
|
+
|
103
|
+
self.action = attributes[:'action']
|
104
|
+
|
105
|
+
|
106
|
+
end
|
107
|
+
|
108
|
+
|
109
|
+
end
|
110
|
+
|
111
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
112
|
+
# @return Array for valid properies with the reasons
|
113
|
+
def list_invalid_properties
|
114
|
+
invalid_properties = Array.new
|
115
|
+
|
116
|
+
|
117
|
+
return invalid_properties
|
118
|
+
end
|
119
|
+
|
120
|
+
# Check to see if the all the properties in the model are valid
|
121
|
+
# @return true if the model is valid
|
122
|
+
def valid?
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
if @text.nil?
|
130
|
+
return false
|
131
|
+
end
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
allowed_values = ["Message"]
|
144
|
+
if @action && !allowed_values.include?(@action)
|
145
|
+
return false
|
146
|
+
end
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
end
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
# Custom attribute writer method checking allowed values (enum).
|
170
|
+
# @param [Object] action Object to be assigned
|
171
|
+
def action=(action)
|
172
|
+
allowed_values = ["Message"]
|
173
|
+
if action && !allowed_values.include?(action)
|
174
|
+
fail ArgumentError, "invalid value for 'action', must be one of #{allowed_values}."
|
175
|
+
end
|
176
|
+
@action = action
|
177
|
+
end
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
# Checks equality by comparing each attribute.
|
183
|
+
# @param [Object] Object to be compared
|
184
|
+
def ==(o)
|
185
|
+
return true if self.equal?(o)
|
186
|
+
self.class == o.class &&
|
187
|
+
id == o.id &&
|
188
|
+
text == o.text &&
|
189
|
+
image == o.image &&
|
190
|
+
action == o.action
|
191
|
+
end
|
192
|
+
|
193
|
+
# @see the `==` method
|
194
|
+
# @param [Object] Object to be compared
|
195
|
+
def eql?(o)
|
196
|
+
self == o
|
197
|
+
end
|
198
|
+
|
199
|
+
# Calculates hash code according to all attributes.
|
200
|
+
# @return [Fixnum] Hash code
|
201
|
+
def hash
|
202
|
+
[id, text, image, action].hash
|
203
|
+
end
|
204
|
+
|
205
|
+
# build the object from hash
|
206
|
+
def build_from_hash(attributes)
|
207
|
+
return nil unless attributes.is_a?(Hash)
|
208
|
+
self.class.swagger_types.each_pair do |key, type|
|
209
|
+
if type =~ /^Array<(.*)>/i
|
210
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
211
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
212
|
+
else
|
213
|
+
#TODO show warning in debug mode
|
214
|
+
end
|
215
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
216
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
217
|
+
else
|
218
|
+
# data not found in attributes(hash), not an issue as the data can be optional
|
219
|
+
end
|
220
|
+
end
|
221
|
+
|
222
|
+
self
|
223
|
+
end
|
224
|
+
|
225
|
+
def _deserialize(type, value)
|
226
|
+
case type.to_sym
|
227
|
+
when :DateTime
|
228
|
+
DateTime.parse(value)
|
229
|
+
when :Date
|
230
|
+
Date.parse(value)
|
231
|
+
when :String
|
232
|
+
value.to_s
|
233
|
+
when :Integer
|
234
|
+
value.to_i
|
235
|
+
when :Float
|
236
|
+
value.to_f
|
237
|
+
when :BOOLEAN
|
238
|
+
if value.to_s =~ /^(true|t|yes|y|1)$/i
|
239
|
+
true
|
240
|
+
else
|
241
|
+
false
|
242
|
+
end
|
243
|
+
when :Object
|
244
|
+
# generic object (usually a Hash), return directly
|
245
|
+
value
|
246
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
247
|
+
inner_type = Regexp.last_match[:inner_type]
|
248
|
+
value.map { |v| _deserialize(inner_type, v) }
|
249
|
+
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
|
250
|
+
k_type = Regexp.last_match[:k_type]
|
251
|
+
v_type = Regexp.last_match[:v_type]
|
252
|
+
{}.tap do |hash|
|
253
|
+
value.each do |k, v|
|
254
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
255
|
+
end
|
256
|
+
end
|
257
|
+
else # model
|
258
|
+
_model = Object.const_get("PureCloud").const_get(type).new
|
259
|
+
_model.build_from_hash(value)
|
260
|
+
end
|
261
|
+
end
|
262
|
+
|
263
|
+
def to_s
|
264
|
+
to_hash.to_s
|
265
|
+
end
|
266
|
+
|
267
|
+
# to_body is an alias to to_body (backward compatibility))
|
268
|
+
def to_body
|
269
|
+
to_hash
|
270
|
+
end
|
271
|
+
|
272
|
+
# return the object in the form of hash
|
273
|
+
def to_hash
|
274
|
+
hash = {}
|
275
|
+
self.class.attribute_map.each_pair do |attr, param|
|
276
|
+
value = self.send(attr)
|
277
|
+
next if value.nil?
|
278
|
+
hash[param] = _to_hash(value)
|
279
|
+
end
|
280
|
+
hash
|
281
|
+
end
|
282
|
+
|
283
|
+
# Method to output non-array value in the form of hash
|
284
|
+
# For object, use to_hash. Otherwise, just return the value
|
285
|
+
def _to_hash(value)
|
286
|
+
if value.is_a?(Array)
|
287
|
+
value.compact.map{ |v| _to_hash(v) }
|
288
|
+
elsif value.is_a?(Hash)
|
289
|
+
{}.tap do |hash|
|
290
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
291
|
+
end
|
292
|
+
elsif value.respond_to? :to_hash
|
293
|
+
value.to_hash
|
294
|
+
else
|
295
|
+
value
|
296
|
+
end
|
297
|
+
end
|
298
|
+
|
299
|
+
end
|
300
|
+
end
|
@@ -54,6 +54,9 @@ module PureCloud
|
|
54
54
|
# Is this edge group being managed remotely.
|
55
55
|
attr_accessor :managed
|
56
56
|
|
57
|
+
# Is this edge group hybrid.
|
58
|
+
attr_accessor :hybrid
|
59
|
+
|
57
60
|
# A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.
|
58
61
|
attr_accessor :edge_trunk_base_assignment
|
59
62
|
|
@@ -91,6 +94,8 @@ module PureCloud
|
|
91
94
|
|
92
95
|
:'managed' => :'managed',
|
93
96
|
|
97
|
+
:'hybrid' => :'hybrid',
|
98
|
+
|
94
99
|
:'edge_trunk_base_assignment' => :'edgeTrunkBaseAssignment',
|
95
100
|
|
96
101
|
:'phone_trunk_bases' => :'phoneTrunkBases',
|
@@ -128,6 +133,8 @@ module PureCloud
|
|
128
133
|
|
129
134
|
:'managed' => :'BOOLEAN',
|
130
135
|
|
136
|
+
:'hybrid' => :'BOOLEAN',
|
137
|
+
|
131
138
|
:'edge_trunk_base_assignment' => :'TrunkBaseAssignment',
|
132
139
|
|
133
140
|
:'phone_trunk_bases' => :'Array<TrunkBase>',
|
@@ -254,6 +261,15 @@ module PureCloud
|
|
254
261
|
end
|
255
262
|
|
256
263
|
|
264
|
+
if attributes.has_key?(:'hybrid')
|
265
|
+
|
266
|
+
|
267
|
+
self.hybrid = attributes[:'hybrid']
|
268
|
+
|
269
|
+
|
270
|
+
end
|
271
|
+
|
272
|
+
|
257
273
|
if attributes.has_key?(:'edgeTrunkBaseAssignment')
|
258
274
|
|
259
275
|
|
@@ -357,6 +373,10 @@ module PureCloud
|
|
357
373
|
|
358
374
|
|
359
375
|
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
360
380
|
if @edge_trunk_base_assignment.nil?
|
361
381
|
return false
|
362
382
|
end
|
@@ -459,6 +479,11 @@ module PureCloud
|
|
459
479
|
|
460
480
|
|
461
481
|
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
462
487
|
|
463
488
|
|
464
489
|
|
@@ -482,6 +507,7 @@ module PureCloud
|
|
482
507
|
modified_by_app == o.modified_by_app &&
|
483
508
|
created_by_app == o.created_by_app &&
|
484
509
|
managed == o.managed &&
|
510
|
+
hybrid == o.hybrid &&
|
485
511
|
edge_trunk_base_assignment == o.edge_trunk_base_assignment &&
|
486
512
|
phone_trunk_bases == o.phone_trunk_bases &&
|
487
513
|
self_uri == o.self_uri
|
@@ -496,7 +522,7 @@ module PureCloud
|
|
496
522
|
# Calculates hash code according to all attributes.
|
497
523
|
# @return [Fixnum] Hash code
|
498
524
|
def hash
|
499
|
-
[id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, managed, edge_trunk_base_assignment, phone_trunk_bases, self_uri].hash
|
525
|
+
[id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, managed, hybrid, edge_trunk_base_assignment, phone_trunk_bases, self_uri].hash
|
500
526
|
end
|
501
527
|
|
502
528
|
# build the object from hash
|
@@ -20,27 +20,11 @@ module PureCloud
|
|
20
20
|
class EntityListing
|
21
21
|
attr_accessor :entities
|
22
22
|
|
23
|
-
attr_accessor :page_size
|
24
|
-
|
25
|
-
attr_accessor :page_number
|
26
|
-
|
27
|
-
attr_accessor :total
|
28
|
-
|
29
|
-
attr_accessor :page_count
|
30
|
-
|
31
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
32
24
|
def self.attribute_map
|
33
25
|
{
|
34
26
|
|
35
|
-
:'entities' => :'entities'
|
36
|
-
|
37
|
-
:'page_size' => :'pageSize',
|
38
|
-
|
39
|
-
:'page_number' => :'pageNumber',
|
40
|
-
|
41
|
-
:'total' => :'total',
|
42
|
-
|
43
|
-
:'page_count' => :'pageCount'
|
27
|
+
:'entities' => :'entities'
|
44
28
|
|
45
29
|
}
|
46
30
|
end
|
@@ -49,15 +33,7 @@ module PureCloud
|
|
49
33
|
def self.swagger_types
|
50
34
|
{
|
51
35
|
|
52
|
-
:'entities' => :'Array<
|
53
|
-
|
54
|
-
:'page_size' => :'Integer',
|
55
|
-
|
56
|
-
:'page_number' => :'Integer',
|
57
|
-
|
58
|
-
:'total' => :'Integer',
|
59
|
-
|
60
|
-
:'page_count' => :'Integer'
|
36
|
+
:'entities' => :'Array<Object>'
|
61
37
|
|
62
38
|
}
|
63
39
|
end
|
@@ -82,42 +58,6 @@ module PureCloud
|
|
82
58
|
end
|
83
59
|
|
84
60
|
|
85
|
-
if attributes.has_key?(:'pageSize')
|
86
|
-
|
87
|
-
|
88
|
-
self.page_size = attributes[:'pageSize']
|
89
|
-
|
90
|
-
|
91
|
-
end
|
92
|
-
|
93
|
-
|
94
|
-
if attributes.has_key?(:'pageNumber')
|
95
|
-
|
96
|
-
|
97
|
-
self.page_number = attributes[:'pageNumber']
|
98
|
-
|
99
|
-
|
100
|
-
end
|
101
|
-
|
102
|
-
|
103
|
-
if attributes.has_key?(:'total')
|
104
|
-
|
105
|
-
|
106
|
-
self.total = attributes[:'total']
|
107
|
-
|
108
|
-
|
109
|
-
end
|
110
|
-
|
111
|
-
|
112
|
-
if attributes.has_key?(:'pageCount')
|
113
|
-
|
114
|
-
|
115
|
-
self.page_count = attributes[:'pageCount']
|
116
|
-
|
117
|
-
|
118
|
-
end
|
119
|
-
|
120
|
-
|
121
61
|
end
|
122
62
|
|
123
63
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -132,22 +72,6 @@ module PureCloud
|
|
132
72
|
# Check to see if the all the properties in the model are valid
|
133
73
|
# @return true if the model is valid
|
134
74
|
def valid?
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
75
|
|
152
76
|
|
153
77
|
|
@@ -160,37 +84,13 @@ module PureCloud
|
|
160
84
|
|
161
85
|
|
162
86
|
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
87
|
|
184
88
|
# Checks equality by comparing each attribute.
|
185
89
|
# @param [Object] Object to be compared
|
186
90
|
def ==(o)
|
187
91
|
return true if self.equal?(o)
|
188
92
|
self.class == o.class &&
|
189
|
-
entities == o.entities
|
190
|
-
page_size == o.page_size &&
|
191
|
-
page_number == o.page_number &&
|
192
|
-
total == o.total &&
|
193
|
-
page_count == o.page_count
|
93
|
+
entities == o.entities
|
194
94
|
end
|
195
95
|
|
196
96
|
# @see the `==` method
|
@@ -202,7 +102,7 @@ module PureCloud
|
|
202
102
|
# Calculates hash code according to all attributes.
|
203
103
|
# @return [Fixnum] Hash code
|
204
104
|
def hash
|
205
|
-
[entities
|
105
|
+
[entities].hash
|
206
106
|
end
|
207
107
|
|
208
108
|
# build the object from hash
|