purecloudplatformclientv2 27.1.0 → 28.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/AdditionalMessage.md +13 -0
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectApi.md +40 -28
- data/docs/Attachment.md +5 -5
- data/docs/ConversationNotificationAttachment.md +18 -0
- data/docs/ConversationNotificationDraftAttachments.md +18 -0
- data/docs/ConversationNotificationEmail.md +1 -0
- data/docs/ConversationNotificationEmails.md +1 -0
- data/docs/ConversationsApi.md +964 -198
- data/docs/DataTable.md +17 -0
- data/docs/DataTableRowEntityListing.md +22 -0
- data/docs/DataTablesDomainEntityListing.md +22 -0
- data/docs/Document.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/Email.md +1 -0
- data/docs/EmailConversationNotificationAttachment.md +18 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/MessageConversation.md +17 -0
- data/docs/MessageConversationEntityListing.md +22 -0
- data/docs/MessageData.md +25 -0
- data/docs/MessageMediaParticipant.md +44 -0
- data/docs/Question.md +1 -1
- data/docs/Recipient.md +20 -0
- data/docs/RecipientListing.md +22 -0
- data/docs/RoutingApi.md +632 -0
- data/docs/SMSAvailablePhoneNumberEntityListing.md +13 -0
- data/docs/SmsAddressProvision.md +21 -0
- data/docs/SmsAvailablePhoneNumber.md +22 -0
- data/docs/SmsPhoneNumber.md +25 -0
- data/docs/SmsPhoneNumberEntityListing.md +22 -0
- data/docs/SmsPhoneNumberProvision.md +18 -0
- data/docs/TextMessageListing.md +22 -0
- data/lib/purecloudplatformclientv2.rb +20 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +108 -34
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +1247 -317
- data/lib/purecloudplatformclientv2/api/routing_api.rb +829 -43
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/additional_message.rb +207 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/attachment.rb +5 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_draft_attachments.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +28 -1
- data/lib/purecloudplatformclientv2/models/data_table.rb +306 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email.rb +32 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +32 -4
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/message_conversation.rb +309 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/message_data.rb +572 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1068 -0
- data/lib/purecloudplatformclientv2/models/question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient.rb +383 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +440 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +465 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +546 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +360 -0
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +42 -2
@@ -0,0 +1,326 @@
|
|
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: ININ
|
11
|
+
http://www.inin.com
|
12
|
+
|
13
|
+
Terms of Service: https://developer.mypurecloud.com/tos
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require 'date'
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class ConversationNotificationDraftAttachments
|
21
|
+
attr_accessor :attachment_id
|
22
|
+
|
23
|
+
attr_accessor :name
|
24
|
+
|
25
|
+
attr_accessor :content_uri
|
26
|
+
|
27
|
+
attr_accessor :content_type
|
28
|
+
|
29
|
+
attr_accessor :content_length
|
30
|
+
|
31
|
+
attr_accessor :additional_properties
|
32
|
+
|
33
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
34
|
+
def self.attribute_map
|
35
|
+
{
|
36
|
+
|
37
|
+
:'attachment_id' => :'attachmentId',
|
38
|
+
|
39
|
+
:'name' => :'name',
|
40
|
+
|
41
|
+
:'content_uri' => :'contentUri',
|
42
|
+
|
43
|
+
:'content_type' => :'contentType',
|
44
|
+
|
45
|
+
:'content_length' => :'contentLength',
|
46
|
+
|
47
|
+
:'additional_properties' => :'additionalProperties'
|
48
|
+
|
49
|
+
}
|
50
|
+
end
|
51
|
+
|
52
|
+
# Attribute type mapping.
|
53
|
+
def self.swagger_types
|
54
|
+
{
|
55
|
+
|
56
|
+
:'attachment_id' => :'String',
|
57
|
+
|
58
|
+
:'name' => :'String',
|
59
|
+
|
60
|
+
:'content_uri' => :'String',
|
61
|
+
|
62
|
+
:'content_type' => :'String',
|
63
|
+
|
64
|
+
:'content_length' => :'Integer',
|
65
|
+
|
66
|
+
:'additional_properties' => :'Object'
|
67
|
+
|
68
|
+
}
|
69
|
+
end
|
70
|
+
|
71
|
+
# Initializes the object
|
72
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
73
|
+
def initialize(attributes = {})
|
74
|
+
return unless attributes.is_a?(Hash)
|
75
|
+
|
76
|
+
# convert string to symbol for hash key
|
77
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
78
|
+
|
79
|
+
|
80
|
+
if attributes.has_key?(:'attachmentId')
|
81
|
+
|
82
|
+
|
83
|
+
self.attachment_id = attributes[:'attachmentId']
|
84
|
+
|
85
|
+
|
86
|
+
end
|
87
|
+
|
88
|
+
|
89
|
+
if attributes.has_key?(:'name')
|
90
|
+
|
91
|
+
|
92
|
+
self.name = attributes[:'name']
|
93
|
+
|
94
|
+
|
95
|
+
end
|
96
|
+
|
97
|
+
|
98
|
+
if attributes.has_key?(:'contentUri')
|
99
|
+
|
100
|
+
|
101
|
+
self.content_uri = attributes[:'contentUri']
|
102
|
+
|
103
|
+
|
104
|
+
end
|
105
|
+
|
106
|
+
|
107
|
+
if attributes.has_key?(:'contentType')
|
108
|
+
|
109
|
+
|
110
|
+
self.content_type = attributes[:'contentType']
|
111
|
+
|
112
|
+
|
113
|
+
end
|
114
|
+
|
115
|
+
|
116
|
+
if attributes.has_key?(:'contentLength')
|
117
|
+
|
118
|
+
|
119
|
+
self.content_length = attributes[:'contentLength']
|
120
|
+
|
121
|
+
|
122
|
+
end
|
123
|
+
|
124
|
+
|
125
|
+
if attributes.has_key?(:'additionalProperties')
|
126
|
+
|
127
|
+
|
128
|
+
self.additional_properties = attributes[:'additionalProperties']
|
129
|
+
|
130
|
+
|
131
|
+
end
|
132
|
+
|
133
|
+
|
134
|
+
end
|
135
|
+
|
136
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
137
|
+
# @return Array for valid properies with the reasons
|
138
|
+
def list_invalid_properties
|
139
|
+
invalid_properties = Array.new
|
140
|
+
|
141
|
+
|
142
|
+
return invalid_properties
|
143
|
+
end
|
144
|
+
|
145
|
+
# Check to see if the all the properties in the model are valid
|
146
|
+
# @return true if the model is valid
|
147
|
+
def valid?
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
end
|
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
|
+
# Checks equality by comparing each attribute.
|
207
|
+
# @param [Object] Object to be compared
|
208
|
+
def ==(o)
|
209
|
+
return true if self.equal?(o)
|
210
|
+
self.class == o.class &&
|
211
|
+
attachment_id == o.attachment_id &&
|
212
|
+
name == o.name &&
|
213
|
+
content_uri == o.content_uri &&
|
214
|
+
content_type == o.content_type &&
|
215
|
+
content_length == o.content_length &&
|
216
|
+
additional_properties == o.additional_properties
|
217
|
+
end
|
218
|
+
|
219
|
+
# @see the `==` method
|
220
|
+
# @param [Object] Object to be compared
|
221
|
+
def eql?(o)
|
222
|
+
self == o
|
223
|
+
end
|
224
|
+
|
225
|
+
# Calculates hash code according to all attributes.
|
226
|
+
# @return [Fixnum] Hash code
|
227
|
+
def hash
|
228
|
+
[attachment_id, name, content_uri, content_type, content_length, additional_properties].hash
|
229
|
+
end
|
230
|
+
|
231
|
+
# build the object from hash
|
232
|
+
def build_from_hash(attributes)
|
233
|
+
return nil unless attributes.is_a?(Hash)
|
234
|
+
self.class.swagger_types.each_pair do |key, type|
|
235
|
+
if type =~ /^Array<(.*)>/i
|
236
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
237
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
238
|
+
else
|
239
|
+
#TODO show warning in debug mode
|
240
|
+
end
|
241
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
242
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
243
|
+
else
|
244
|
+
# data not found in attributes(hash), not an issue as the data can be optional
|
245
|
+
end
|
246
|
+
end
|
247
|
+
|
248
|
+
self
|
249
|
+
end
|
250
|
+
|
251
|
+
def _deserialize(type, value)
|
252
|
+
case type.to_sym
|
253
|
+
when :DateTime
|
254
|
+
DateTime.parse(value)
|
255
|
+
when :Date
|
256
|
+
Date.parse(value)
|
257
|
+
when :String
|
258
|
+
value.to_s
|
259
|
+
when :Integer
|
260
|
+
value.to_i
|
261
|
+
when :Float
|
262
|
+
value.to_f
|
263
|
+
when :BOOLEAN
|
264
|
+
if value.to_s =~ /^(true|t|yes|y|1)$/i
|
265
|
+
true
|
266
|
+
else
|
267
|
+
false
|
268
|
+
end
|
269
|
+
when :Object
|
270
|
+
# generic object (usually a Hash), return directly
|
271
|
+
value
|
272
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
273
|
+
inner_type = Regexp.last_match[:inner_type]
|
274
|
+
value.map { |v| _deserialize(inner_type, v) }
|
275
|
+
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
|
276
|
+
k_type = Regexp.last_match[:k_type]
|
277
|
+
v_type = Regexp.last_match[:v_type]
|
278
|
+
{}.tap do |hash|
|
279
|
+
value.each do |k, v|
|
280
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
281
|
+
end
|
282
|
+
end
|
283
|
+
else # model
|
284
|
+
_model = Object.const_get("PureCloud").const_get(type).new
|
285
|
+
_model.build_from_hash(value)
|
286
|
+
end
|
287
|
+
end
|
288
|
+
|
289
|
+
def to_s
|
290
|
+
to_hash.to_s
|
291
|
+
end
|
292
|
+
|
293
|
+
# to_body is an alias to to_body (backward compatibility))
|
294
|
+
def to_body
|
295
|
+
to_hash
|
296
|
+
end
|
297
|
+
|
298
|
+
# return the object in the form of hash
|
299
|
+
def to_hash
|
300
|
+
hash = {}
|
301
|
+
self.class.attribute_map.each_pair do |attr, param|
|
302
|
+
value = self.send(attr)
|
303
|
+
next if value.nil?
|
304
|
+
hash[param] = _to_hash(value)
|
305
|
+
end
|
306
|
+
hash
|
307
|
+
end
|
308
|
+
|
309
|
+
# Method to output non-array value in the form of hash
|
310
|
+
# For object, use to_hash. Otherwise, just return the value
|
311
|
+
def _to_hash(value)
|
312
|
+
if value.is_a?(Array)
|
313
|
+
value.compact.map{ |v| _to_hash(v) }
|
314
|
+
elsif value.is_a?(Hash)
|
315
|
+
{}.tap do |hash|
|
316
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
317
|
+
end
|
318
|
+
elsif value.respond_to? :to_hash
|
319
|
+
value.to_hash
|
320
|
+
else
|
321
|
+
value
|
322
|
+
end
|
323
|
+
end
|
324
|
+
|
325
|
+
end
|
326
|
+
end
|
@@ -50,6 +50,8 @@ module PureCloud
|
|
50
50
|
|
51
51
|
attr_accessor :direction
|
52
52
|
|
53
|
+
attr_accessor :draft_attachments
|
54
|
+
|
53
55
|
attr_accessor :additional_properties
|
54
56
|
|
55
57
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -88,6 +90,8 @@ module PureCloud
|
|
88
90
|
|
89
91
|
:'direction' => :'direction',
|
90
92
|
|
93
|
+
:'draft_attachments' => :'draftAttachments',
|
94
|
+
|
91
95
|
:'additional_properties' => :'additionalProperties'
|
92
96
|
|
93
97
|
}
|
@@ -129,6 +133,8 @@ module PureCloud
|
|
129
133
|
|
130
134
|
:'direction' => :'String',
|
131
135
|
|
136
|
+
:'draft_attachments' => :'Array<ConversationNotificationDraftAttachments>',
|
137
|
+
|
132
138
|
:'additional_properties' => :'Object'
|
133
139
|
|
134
140
|
}
|
@@ -287,6 +293,17 @@ module PureCloud
|
|
287
293
|
end
|
288
294
|
|
289
295
|
|
296
|
+
if attributes.has_key?(:'draftAttachments')
|
297
|
+
|
298
|
+
if (value = attributes[:'draftAttachments']).is_a?(Array)
|
299
|
+
self.draft_attachments = value
|
300
|
+
end
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
end
|
305
|
+
|
306
|
+
|
290
307
|
if attributes.has_key?(:'additionalProperties')
|
291
308
|
|
292
309
|
|
@@ -394,6 +411,10 @@ module PureCloud
|
|
394
411
|
|
395
412
|
|
396
413
|
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
397
418
|
end
|
398
419
|
|
399
420
|
|
@@ -509,6 +530,11 @@ module PureCloud
|
|
509
530
|
|
510
531
|
|
511
532
|
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
512
538
|
# Checks equality by comparing each attribute.
|
513
539
|
# @param [Object] Object to be compared
|
514
540
|
def ==(o)
|
@@ -530,6 +556,7 @@ module PureCloud
|
|
530
556
|
disconnected_time == o.disconnected_time &&
|
531
557
|
message_id == o.message_id &&
|
532
558
|
direction == o.direction &&
|
559
|
+
draft_attachments == o.draft_attachments &&
|
533
560
|
additional_properties == o.additional_properties
|
534
561
|
end
|
535
562
|
|
@@ -542,7 +569,7 @@ module PureCloud
|
|
542
569
|
# Calculates hash code according to all attributes.
|
543
570
|
# @return [Fixnum] Hash code
|
544
571
|
def hash
|
545
|
-
[id, state, held, auto_generated, subject, provider, script_id, peer_id, messages_sent, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, message_id, direction, additional_properties].hash
|
572
|
+
[id, state, held, auto_generated, subject, provider, script_id, peer_id, messages_sent, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, message_id, direction, draft_attachments, additional_properties].hash
|
546
573
|
end
|
547
574
|
|
548
575
|
# build the object from hash
|
@@ -50,6 +50,8 @@ module PureCloud
|
|
50
50
|
|
51
51
|
attr_accessor :direction
|
52
52
|
|
53
|
+
attr_accessor :draft_attachments
|
54
|
+
|
53
55
|
attr_accessor :additional_properties
|
54
56
|
|
55
57
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -88,6 +90,8 @@ module PureCloud
|
|
88
90
|
|
89
91
|
:'direction' => :'direction',
|
90
92
|
|
93
|
+
:'draft_attachments' => :'draftAttachments',
|
94
|
+
|
91
95
|
:'additional_properties' => :'additionalProperties'
|
92
96
|
|
93
97
|
}
|
@@ -129,6 +133,8 @@ module PureCloud
|
|
129
133
|
|
130
134
|
:'direction' => :'String',
|
131
135
|
|
136
|
+
:'draft_attachments' => :'Array<ConversationNotificationDraftAttachments>',
|
137
|
+
|
132
138
|
:'additional_properties' => :'Object'
|
133
139
|
|
134
140
|
}
|
@@ -287,6 +293,17 @@ module PureCloud
|
|
287
293
|
end
|
288
294
|
|
289
295
|
|
296
|
+
if attributes.has_key?(:'draftAttachments')
|
297
|
+
|
298
|
+
if (value = attributes[:'draftAttachments']).is_a?(Array)
|
299
|
+
self.draft_attachments = value
|
300
|
+
end
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
end
|
305
|
+
|
306
|
+
|
290
307
|
if attributes.has_key?(:'additionalProperties')
|
291
308
|
|
292
309
|
|
@@ -394,6 +411,10 @@ module PureCloud
|
|
394
411
|
|
395
412
|
|
396
413
|
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
397
418
|
end
|
398
419
|
|
399
420
|
|
@@ -509,6 +530,11 @@ module PureCloud
|
|
509
530
|
|
510
531
|
|
511
532
|
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
512
538
|
# Checks equality by comparing each attribute.
|
513
539
|
# @param [Object] Object to be compared
|
514
540
|
def ==(o)
|
@@ -530,6 +556,7 @@ module PureCloud
|
|
530
556
|
disconnected_time == o.disconnected_time &&
|
531
557
|
message_id == o.message_id &&
|
532
558
|
direction == o.direction &&
|
559
|
+
draft_attachments == o.draft_attachments &&
|
533
560
|
additional_properties == o.additional_properties
|
534
561
|
end
|
535
562
|
|
@@ -542,7 +569,7 @@ module PureCloud
|
|
542
569
|
# Calculates hash code according to all attributes.
|
543
570
|
# @return [Fixnum] Hash code
|
544
571
|
def hash
|
545
|
-
[id, state, held, auto_generated, subject, provider, script_id, peer_id, messages_sent, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, message_id, direction, additional_properties].hash
|
572
|
+
[id, state, held, auto_generated, subject, provider, script_id, peer_id, messages_sent, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, message_id, direction, draft_attachments, additional_properties].hash
|
546
573
|
end
|
547
574
|
|
548
575
|
# build the object from hash
|