purecloudplatformclientv2 27.1.0 → 28.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdditionalMessage.md +13 -0
  4. data/docs/AnalyticsParticipant.md +1 -0
  5. data/docs/ArchitectApi.md +40 -28
  6. data/docs/Attachment.md +5 -5
  7. data/docs/ConversationNotificationAttachment.md +18 -0
  8. data/docs/ConversationNotificationDraftAttachments.md +18 -0
  9. data/docs/ConversationNotificationEmail.md +1 -0
  10. data/docs/ConversationNotificationEmails.md +1 -0
  11. data/docs/ConversationsApi.md +964 -198
  12. data/docs/DataTable.md +17 -0
  13. data/docs/DataTableRowEntityListing.md +22 -0
  14. data/docs/DataTablesDomainEntityListing.md +22 -0
  15. data/docs/Document.md +1 -1
  16. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  17. data/docs/DomainOrganizationRole.md +1 -1
  18. data/docs/DomainOrganizationRoleCreate.md +1 -1
  19. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  20. data/docs/Email.md +1 -0
  21. data/docs/EmailConversationNotificationAttachment.md +18 -0
  22. data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
  23. data/docs/EmailConversationNotificationParticipants.md +1 -0
  24. data/docs/EmailMediaParticipant.md +1 -0
  25. data/docs/FaxDocument.md +1 -1
  26. data/docs/JsonNode.md +4 -4
  27. data/docs/MessageConversation.md +17 -0
  28. data/docs/MessageConversationEntityListing.md +22 -0
  29. data/docs/MessageData.md +25 -0
  30. data/docs/MessageMediaParticipant.md +44 -0
  31. data/docs/Question.md +1 -1
  32. data/docs/Recipient.md +20 -0
  33. data/docs/RecipientListing.md +22 -0
  34. data/docs/RoutingApi.md +632 -0
  35. data/docs/SMSAvailablePhoneNumberEntityListing.md +13 -0
  36. data/docs/SmsAddressProvision.md +21 -0
  37. data/docs/SmsAvailablePhoneNumber.md +22 -0
  38. data/docs/SmsPhoneNumber.md +25 -0
  39. data/docs/SmsPhoneNumberEntityListing.md +22 -0
  40. data/docs/SmsPhoneNumberProvision.md +18 -0
  41. data/docs/TextMessageListing.md +22 -0
  42. data/lib/purecloudplatformclientv2.rb +20 -0
  43. data/lib/purecloudplatformclientv2/api/architect_api.rb +108 -34
  44. data/lib/purecloudplatformclientv2/api/conversations_api.rb +1247 -317
  45. data/lib/purecloudplatformclientv2/api/routing_api.rb +829 -43
  46. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  47. data/lib/purecloudplatformclientv2/models/additional_message.rb +207 -0
  48. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  49. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +41 -1
  50. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  51. data/lib/purecloudplatformclientv2/models/attachment.rb +5 -0
  52. data/lib/purecloudplatformclientv2/models/conversation_notification_attachment.rb +326 -0
  53. data/lib/purecloudplatformclientv2/models/conversation_notification_draft_attachments.rb +326 -0
  54. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +28 -1
  55. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +28 -1
  56. data/lib/purecloudplatformclientv2/models/data_table.rb +306 -0
  57. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +428 -0
  58. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +428 -0
  59. data/lib/purecloudplatformclientv2/models/document.rb +12 -12
  60. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  61. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  62. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  63. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  64. data/lib/purecloudplatformclientv2/models/email.rb +32 -4
  65. data/lib/purecloudplatformclientv2/models/email_conversation_notification_attachment.rb +326 -0
  66. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +31 -4
  67. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +31 -4
  68. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +32 -4
  69. data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
  70. data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
  71. data/lib/purecloudplatformclientv2/models/message_conversation.rb +309 -0
  72. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +428 -0
  73. data/lib/purecloudplatformclientv2/models/message_data.rb +572 -0
  74. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1068 -0
  75. data/lib/purecloudplatformclientv2/models/question.rb +13 -13
  76. data/lib/purecloudplatformclientv2/models/recipient.rb +383 -0
  77. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +428 -0
  78. data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +440 -0
  79. data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +465 -0
  80. data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +203 -0
  81. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +546 -0
  82. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +428 -0
  83. data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +360 -0
  84. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +428 -0
  85. data/lib/purecloudplatformclientv2/version.rb +1 -1
  86. metadata +42 -2
@@ -41,10 +41,10 @@ module PureCloud
41
41
  # Prompt for details explaining the chosen NPS score. Used by NPS questions.
42
42
  attr_accessor :explanation_prompt
43
43
 
44
- attr_accessor :is_kill
45
-
46
44
  attr_accessor :is_critical
47
45
 
46
+ attr_accessor :is_kill
47
+
48
48
  # Attribute mapping from ruby-style variable name to JSON key.
49
49
  def self.attribute_map
50
50
  {
@@ -69,9 +69,9 @@ module PureCloud
69
69
 
70
70
  :'explanation_prompt' => :'explanationPrompt',
71
71
 
72
- :'is_kill' => :'isKill',
72
+ :'is_critical' => :'isCritical',
73
73
 
74
- :'is_critical' => :'isCritical'
74
+ :'is_kill' => :'isKill'
75
75
 
76
76
  }
77
77
  end
@@ -100,9 +100,9 @@ module PureCloud
100
100
 
101
101
  :'explanation_prompt' => :'String',
102
102
 
103
- :'is_kill' => :'BOOLEAN',
103
+ :'is_critical' => :'BOOLEAN',
104
104
 
105
- :'is_critical' => :'BOOLEAN'
105
+ :'is_kill' => :'BOOLEAN'
106
106
 
107
107
  }
108
108
  end
@@ -208,19 +208,19 @@ module PureCloud
208
208
  end
209
209
 
210
210
 
211
- if attributes.has_key?(:'isKill')
211
+ if attributes.has_key?(:'isCritical')
212
212
 
213
213
 
214
- self.is_kill = attributes[:'isKill']
214
+ self.is_critical = attributes[:'isCritical']
215
215
 
216
216
 
217
217
  end
218
218
 
219
219
 
220
- if attributes.has_key?(:'isCritical')
220
+ if attributes.has_key?(:'isKill')
221
221
 
222
222
 
223
- self.is_critical = attributes[:'isCritical']
223
+ self.is_kill = attributes[:'isKill']
224
224
 
225
225
 
226
226
  end
@@ -381,8 +381,8 @@ module PureCloud
381
381
  answer_options == o.answer_options &&
382
382
  max_response_characters == o.max_response_characters &&
383
383
  explanation_prompt == o.explanation_prompt &&
384
- is_kill == o.is_kill &&
385
- is_critical == o.is_critical
384
+ is_critical == o.is_critical &&
385
+ is_kill == o.is_kill
386
386
  end
387
387
 
388
388
  # @see the `==` method
@@ -394,7 +394,7 @@ module PureCloud
394
394
  # Calculates hash code according to all attributes.
395
395
  # @return [Fixnum] Hash code
396
396
  def hash
397
- [id, text, help_text, type, na_enabled, comments_required, visibility_condition, answer_options, max_response_characters, explanation_prompt, is_kill, is_critical].hash
397
+ [id, text, help_text, type, na_enabled, comments_required, visibility_condition, answer_options, max_response_characters, explanation_prompt, is_critical, is_kill].hash
398
398
  end
399
399
 
400
400
  # build the object from hash
@@ -0,0 +1,383 @@
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 Recipient
21
+ # The globally unique identifier for the object.
22
+ attr_accessor :id
23
+
24
+ attr_accessor :name
25
+
26
+ # An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number.
27
+ attr_accessor :flow
28
+
29
+ # Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
30
+ attr_accessor :date_created
31
+
32
+ # Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
33
+ attr_accessor :date_modified
34
+
35
+ # User that created this recipient
36
+ attr_accessor :created_by
37
+
38
+ # User that modified this recipient
39
+ attr_accessor :modified_by
40
+
41
+ # The URI for this object
42
+ attr_accessor :self_uri
43
+
44
+ # Attribute mapping from ruby-style variable name to JSON key.
45
+ def self.attribute_map
46
+ {
47
+
48
+ :'id' => :'id',
49
+
50
+ :'name' => :'name',
51
+
52
+ :'flow' => :'flow',
53
+
54
+ :'date_created' => :'dateCreated',
55
+
56
+ :'date_modified' => :'dateModified',
57
+
58
+ :'created_by' => :'createdBy',
59
+
60
+ :'modified_by' => :'modifiedBy',
61
+
62
+ :'self_uri' => :'selfUri'
63
+
64
+ }
65
+ end
66
+
67
+ # Attribute type mapping.
68
+ def self.swagger_types
69
+ {
70
+
71
+ :'id' => :'String',
72
+
73
+ :'name' => :'String',
74
+
75
+ :'flow' => :'Flow',
76
+
77
+ :'date_created' => :'DateTime',
78
+
79
+ :'date_modified' => :'DateTime',
80
+
81
+ :'created_by' => :'User',
82
+
83
+ :'modified_by' => :'User',
84
+
85
+ :'self_uri' => :'String'
86
+
87
+ }
88
+ end
89
+
90
+ # Initializes the object
91
+ # @param [Hash] attributes Model attributes in the form of hash
92
+ def initialize(attributes = {})
93
+ return unless attributes.is_a?(Hash)
94
+
95
+ # convert string to symbol for hash key
96
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
97
+
98
+
99
+ if attributes.has_key?(:'id')
100
+
101
+
102
+ self.id = attributes[:'id']
103
+
104
+
105
+ end
106
+
107
+
108
+ if attributes.has_key?(:'name')
109
+
110
+
111
+ self.name = attributes[:'name']
112
+
113
+
114
+ end
115
+
116
+
117
+ if attributes.has_key?(:'flow')
118
+
119
+
120
+ self.flow = attributes[:'flow']
121
+
122
+
123
+ end
124
+
125
+
126
+ if attributes.has_key?(:'dateCreated')
127
+
128
+
129
+ self.date_created = attributes[:'dateCreated']
130
+
131
+
132
+ end
133
+
134
+
135
+ if attributes.has_key?(:'dateModified')
136
+
137
+
138
+ self.date_modified = attributes[:'dateModified']
139
+
140
+
141
+ end
142
+
143
+
144
+ if attributes.has_key?(:'createdBy')
145
+
146
+
147
+ self.created_by = attributes[:'createdBy']
148
+
149
+
150
+ end
151
+
152
+
153
+ if attributes.has_key?(:'modifiedBy')
154
+
155
+
156
+ self.modified_by = attributes[:'modifiedBy']
157
+
158
+
159
+ end
160
+
161
+
162
+ if attributes.has_key?(:'selfUri')
163
+
164
+
165
+ self.self_uri = attributes[:'selfUri']
166
+
167
+
168
+ end
169
+
170
+
171
+ end
172
+
173
+ # Show invalid properties with the reasons. Usually used together with valid?
174
+ # @return Array for valid properies with the reasons
175
+ def list_invalid_properties
176
+ invalid_properties = Array.new
177
+
178
+
179
+ return invalid_properties
180
+ end
181
+
182
+ # Check to see if the all the properties in the model are valid
183
+ # @return true if the model is valid
184
+ def valid?
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
+
213
+
214
+
215
+
216
+
217
+
218
+ end
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
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
+ # Checks equality by comparing each attribute.
262
+ # @param [Object] Object to be compared
263
+ def ==(o)
264
+ return true if self.equal?(o)
265
+ self.class == o.class &&
266
+ id == o.id &&
267
+ name == o.name &&
268
+ flow == o.flow &&
269
+ date_created == o.date_created &&
270
+ date_modified == o.date_modified &&
271
+ created_by == o.created_by &&
272
+ modified_by == o.modified_by &&
273
+ self_uri == o.self_uri
274
+ end
275
+
276
+ # @see the `==` method
277
+ # @param [Object] Object to be compared
278
+ def eql?(o)
279
+ self == o
280
+ end
281
+
282
+ # Calculates hash code according to all attributes.
283
+ # @return [Fixnum] Hash code
284
+ def hash
285
+ [id, name, flow, date_created, date_modified, created_by, modified_by, self_uri].hash
286
+ end
287
+
288
+ # build the object from hash
289
+ def build_from_hash(attributes)
290
+ return nil unless attributes.is_a?(Hash)
291
+ self.class.swagger_types.each_pair do |key, type|
292
+ if type =~ /^Array<(.*)>/i
293
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
294
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
295
+ else
296
+ #TODO show warning in debug mode
297
+ end
298
+ elsif !attributes[self.class.attribute_map[key]].nil?
299
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
300
+ else
301
+ # data not found in attributes(hash), not an issue as the data can be optional
302
+ end
303
+ end
304
+
305
+ self
306
+ end
307
+
308
+ def _deserialize(type, value)
309
+ case type.to_sym
310
+ when :DateTime
311
+ DateTime.parse(value)
312
+ when :Date
313
+ Date.parse(value)
314
+ when :String
315
+ value.to_s
316
+ when :Integer
317
+ value.to_i
318
+ when :Float
319
+ value.to_f
320
+ when :BOOLEAN
321
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
322
+ true
323
+ else
324
+ false
325
+ end
326
+ when :Object
327
+ # generic object (usually a Hash), return directly
328
+ value
329
+ when /\AArray<(?<inner_type>.+)>\z/
330
+ inner_type = Regexp.last_match[:inner_type]
331
+ value.map { |v| _deserialize(inner_type, v) }
332
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
333
+ k_type = Regexp.last_match[:k_type]
334
+ v_type = Regexp.last_match[:v_type]
335
+ {}.tap do |hash|
336
+ value.each do |k, v|
337
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
338
+ end
339
+ end
340
+ else # model
341
+ _model = Object.const_get("PureCloud").const_get(type).new
342
+ _model.build_from_hash(value)
343
+ end
344
+ end
345
+
346
+ def to_s
347
+ to_hash.to_s
348
+ end
349
+
350
+ # to_body is an alias to to_body (backward compatibility))
351
+ def to_body
352
+ to_hash
353
+ end
354
+
355
+ # return the object in the form of hash
356
+ def to_hash
357
+ hash = {}
358
+ self.class.attribute_map.each_pair do |attr, param|
359
+ value = self.send(attr)
360
+ next if value.nil?
361
+ hash[param] = _to_hash(value)
362
+ end
363
+ hash
364
+ end
365
+
366
+ # Method to output non-array value in the form of hash
367
+ # For object, use to_hash. Otherwise, just return the value
368
+ def _to_hash(value)
369
+ if value.is_a?(Array)
370
+ value.compact.map{ |v| _to_hash(v) }
371
+ elsif value.is_a?(Hash)
372
+ {}.tap do |hash|
373
+ value.each { |k, v| hash[k] = _to_hash(v) }
374
+ end
375
+ elsif value.respond_to? :to_hash
376
+ value.to_hash
377
+ else
378
+ value
379
+ end
380
+ end
381
+
382
+ end
383
+ end