purecloudplatformclientv2 20.0.0 → 21.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdherenceSettings.md +18 -0
  4. data/docs/AgentManagementUnitReference.md +14 -0
  5. data/docs/AnalyticsSession.md +1 -0
  6. data/docs/AnalyticsView.md +1 -1
  7. data/docs/ArchitectApi.md +19 -15
  8. data/docs/CallForwarding.md +4 -2
  9. data/docs/CallMediaParticipant.md +1 -0
  10. data/docs/CallRoute.md +14 -0
  11. data/docs/CallTarget.md +14 -0
  12. data/docs/Contact.md +1 -1
  13. data/docs/ConversationNotificationMessage.md +3 -0
  14. data/docs/ConversationNotificationMessageDetails.md +2 -0
  15. data/docs/ConversationNotificationMessages.md +2 -0
  16. data/docs/ConversationNotificationMessages1.md +3 -0
  17. data/docs/ConversationsApi.md +196 -0
  18. data/docs/CreateEmailRequest.md +2 -0
  19. data/docs/CreateQueueRequest.md +2 -0
  20. data/docs/CreateSecureSession.md +16 -0
  21. data/docs/ExternalContact.md +1 -0
  22. data/docs/ImportScriptStatusResponse.md +15 -0
  23. data/docs/InboundRoute.md +1 -0
  24. data/docs/JsonNode.md +1 -1
  25. data/docs/ManagementUnit.md +5 -3
  26. data/docs/ManagementUnitReference.md +14 -0
  27. data/docs/ManagementUnitSettings.md +19 -0
  28. data/docs/Message.md +3 -0
  29. data/docs/MessageConversationNotificationMessageDetails.md +2 -0
  30. data/docs/MessageConversationNotificationMessageMediaParticipant.md +3 -0
  31. data/docs/MessageConversationNotificationMessages.md +2 -0
  32. data/docs/MessageConversationNotificationParticipants.md +3 -0
  33. data/docs/MessageDetails.md +2 -0
  34. data/docs/QualityApi.md +3 -1
  35. data/docs/Queue.md +2 -0
  36. data/docs/SchedulingSettings.md +14 -0
  37. data/docs/ScriptsApi.md +64 -0
  38. data/docs/SecureSession.md +19 -0
  39. data/docs/SecureSessionEntityListing.md +13 -0
  40. data/docs/ShortTermForecastingSettings.md +13 -0
  41. data/docs/SignedData.md +13 -0
  42. data/docs/SignedDataApi.md +73 -0
  43. data/docs/TimeOffRequestSettings.md +15 -0
  44. data/docs/UpdateUser.md +2 -2
  45. data/docs/UserConversationSummaryNotification.md +1 -0
  46. data/docs/UserQueue.md +2 -0
  47. data/docs/UserReference.md +14 -0
  48. data/docs/WorkforceManagementApi.md +61 -0
  49. data/lib/purecloudplatformclientv2.rb +16 -0
  50. data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
  51. data/lib/purecloudplatformclientv2/api/conversations_api.rb +243 -0
  52. data/lib/purecloudplatformclientv2/api/quality_api.rb +9 -0
  53. data/lib/purecloudplatformclientv2/api/scripts_api.rb +74 -0
  54. data/lib/purecloudplatformclientv2/api/signed_data_api.rb +90 -0
  55. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +63 -0
  56. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  57. data/lib/purecloudplatformclientv2/models/adherence_settings.rb +335 -0
  58. data/lib/purecloudplatformclientv2/models/agent_management_unit_reference.rb +229 -0
  59. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  60. data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +2 -2
  61. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  62. data/lib/purecloudplatformclientv2/models/analytics_session.rb +41 -1
  63. data/lib/purecloudplatformclientv2/models/analytics_view.rb +1 -1
  64. data/lib/purecloudplatformclientv2/models/call_forwarding.rb +71 -1
  65. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +30 -4
  66. data/lib/purecloudplatformclientv2/models/call_route.rb +230 -0
  67. data/lib/purecloudplatformclientv2/models/call_target.rb +242 -0
  68. data/lib/purecloudplatformclientv2/models/contact.rb +1 -1
  69. data/lib/purecloudplatformclientv2/models/conversation_notification_message.rb +90 -1
  70. data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +68 -4
  71. data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +68 -4
  72. data/lib/purecloudplatformclientv2/models/conversation_notification_messages_1.rb +90 -1
  73. data/lib/purecloudplatformclientv2/models/create_email_request.rb +56 -4
  74. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +53 -1
  75. data/lib/purecloudplatformclientv2/models/create_secure_session.rb +290 -0
  76. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  77. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  78. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  79. data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
  80. data/lib/purecloudplatformclientv2/models/import_script_status_response.rb +251 -0
  81. data/lib/purecloudplatformclientv2/models/inbound_route.rb +27 -1
  82. data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +2 -2
  83. data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +2 -2
  84. data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
  85. data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +2 -2
  87. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
  88. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
  89. data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
  90. data/lib/purecloudplatformclientv2/models/management_unit.rb +59 -7
  91. data/lib/purecloudplatformclientv2/models/management_unit_reference.rb +229 -0
  92. data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +364 -0
  93. data/lib/purecloudplatformclientv2/models/message.rb +93 -1
  94. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +68 -4
  95. data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +93 -4
  96. data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +68 -4
  97. data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +93 -4
  98. data/lib/purecloudplatformclientv2/models/message_details.rb +67 -1
  99. data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
  100. data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
  101. data/lib/purecloudplatformclientv2/models/queue.rb +53 -1
  102. data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +229 -0
  103. data/lib/purecloudplatformclientv2/models/secure_session.rb +382 -0
  104. data/lib/purecloudplatformclientv2/models/secure_session_entity_listing.rb +203 -0
  105. data/lib/purecloudplatformclientv2/models/short_term_forecasting_settings.rb +203 -0
  106. data/lib/purecloudplatformclientv2/models/signed_data.rb +201 -0
  107. data/lib/purecloudplatformclientv2/models/time_off_request_settings.rb +255 -0
  108. data/lib/purecloudplatformclientv2/models/update_user.rb +2 -1
  109. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +26 -1
  110. data/lib/purecloudplatformclientv2/models/user_queue.rb +53 -1
  111. data/lib/purecloudplatformclientv2/models/user_reference.rb +228 -0
  112. data/lib/purecloudplatformclientv2/version.rb +1 -1
  113. metadata +34 -2
@@ -0,0 +1,364 @@
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
+ # Management Unit Settings
21
+ class ManagementUnitSettings
22
+ # Adherence settings for this management unit
23
+ attr_accessor :adherence
24
+
25
+ # Short term forecasting settings for this management unit
26
+ attr_accessor :short_term_forecasting
27
+
28
+ # Time off request settings for this management unit
29
+ attr_accessor :time_off
30
+
31
+ # Scheduling settings for this management unit
32
+ attr_accessor :scheduling
33
+
34
+ # The version of the underlying entity
35
+ attr_accessor :version
36
+
37
+ # The date and time at which this entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
38
+ attr_accessor :date_modified
39
+
40
+ # The user who last modified this entity
41
+ attr_accessor :modified_by
42
+
43
+ # Attribute mapping from ruby-style variable name to JSON key.
44
+ def self.attribute_map
45
+ {
46
+
47
+ :'adherence' => :'adherence',
48
+
49
+ :'short_term_forecasting' => :'shortTermForecasting',
50
+
51
+ :'time_off' => :'timeOff',
52
+
53
+ :'scheduling' => :'scheduling',
54
+
55
+ :'version' => :'version',
56
+
57
+ :'date_modified' => :'dateModified',
58
+
59
+ :'modified_by' => :'modifiedBy'
60
+
61
+ }
62
+ end
63
+
64
+ # Attribute type mapping.
65
+ def self.swagger_types
66
+ {
67
+
68
+ :'adherence' => :'AdherenceSettings',
69
+
70
+ :'short_term_forecasting' => :'ShortTermForecastingSettings',
71
+
72
+ :'time_off' => :'TimeOffRequestSettings',
73
+
74
+ :'scheduling' => :'SchedulingSettings',
75
+
76
+ :'version' => :'Integer',
77
+
78
+ :'date_modified' => :'DateTime',
79
+
80
+ :'modified_by' => :'User'
81
+
82
+ }
83
+ end
84
+
85
+ # Initializes the object
86
+ # @param [Hash] attributes Model attributes in the form of hash
87
+ def initialize(attributes = {})
88
+ return unless attributes.is_a?(Hash)
89
+
90
+ # convert string to symbol for hash key
91
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
92
+
93
+
94
+ if attributes.has_key?(:'adherence')
95
+
96
+
97
+ self.adherence = attributes[:'adherence']
98
+
99
+
100
+ end
101
+
102
+
103
+ if attributes.has_key?(:'shortTermForecasting')
104
+
105
+
106
+ self.short_term_forecasting = attributes[:'shortTermForecasting']
107
+
108
+
109
+ end
110
+
111
+
112
+ if attributes.has_key?(:'timeOff')
113
+
114
+
115
+ self.time_off = attributes[:'timeOff']
116
+
117
+
118
+ end
119
+
120
+
121
+ if attributes.has_key?(:'scheduling')
122
+
123
+
124
+ self.scheduling = attributes[:'scheduling']
125
+
126
+
127
+ end
128
+
129
+
130
+ if attributes.has_key?(:'version')
131
+
132
+
133
+ self.version = attributes[:'version']
134
+
135
+
136
+ end
137
+
138
+
139
+ if attributes.has_key?(:'dateModified')
140
+
141
+
142
+ self.date_modified = attributes[:'dateModified']
143
+
144
+
145
+ end
146
+
147
+
148
+ if attributes.has_key?(:'modifiedBy')
149
+
150
+
151
+ self.modified_by = attributes[:'modifiedBy']
152
+
153
+
154
+ end
155
+
156
+
157
+ end
158
+
159
+ # Show invalid properties with the reasons. Usually used together with valid?
160
+ # @return Array for valid properies with the reasons
161
+ def list_invalid_properties
162
+ invalid_properties = Array.new
163
+
164
+
165
+ return invalid_properties
166
+ end
167
+
168
+ # Check to see if the all the properties in the model are valid
169
+ # @return true if the model is valid
170
+ def valid?
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ if @version.nil?
190
+ return false
191
+ end
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ end
206
+
207
+
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
+
240
+
241
+
242
+
243
+ # Checks equality by comparing each attribute.
244
+ # @param [Object] Object to be compared
245
+ def ==(o)
246
+ return true if self.equal?(o)
247
+ self.class == o.class &&
248
+ adherence == o.adherence &&
249
+ short_term_forecasting == o.short_term_forecasting &&
250
+ time_off == o.time_off &&
251
+ scheduling == o.scheduling &&
252
+ version == o.version &&
253
+ date_modified == o.date_modified &&
254
+ modified_by == o.modified_by
255
+ end
256
+
257
+ # @see the `==` method
258
+ # @param [Object] Object to be compared
259
+ def eql?(o)
260
+ self == o
261
+ end
262
+
263
+ # Calculates hash code according to all attributes.
264
+ # @return [Fixnum] Hash code
265
+ def hash
266
+ [adherence, short_term_forecasting, time_off, scheduling, version, date_modified, modified_by].hash
267
+ end
268
+
269
+ # build the object from hash
270
+ def build_from_hash(attributes)
271
+ return nil unless attributes.is_a?(Hash)
272
+ self.class.swagger_types.each_pair do |key, type|
273
+ if type =~ /^Array<(.*)>/i
274
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
275
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
276
+ else
277
+ #TODO show warning in debug mode
278
+ end
279
+ elsif !attributes[self.class.attribute_map[key]].nil?
280
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
281
+ else
282
+ # data not found in attributes(hash), not an issue as the data can be optional
283
+ end
284
+ end
285
+
286
+ self
287
+ end
288
+
289
+ def _deserialize(type, value)
290
+ case type.to_sym
291
+ when :DateTime
292
+ DateTime.parse(value)
293
+ when :Date
294
+ Date.parse(value)
295
+ when :String
296
+ value.to_s
297
+ when :Integer
298
+ value.to_i
299
+ when :Float
300
+ value.to_f
301
+ when :BOOLEAN
302
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
303
+ true
304
+ else
305
+ false
306
+ end
307
+ when :Object
308
+ # generic object (usually a Hash), return directly
309
+ value
310
+ when /\AArray<(?<inner_type>.+)>\z/
311
+ inner_type = Regexp.last_match[:inner_type]
312
+ value.map { |v| _deserialize(inner_type, v) }
313
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
314
+ k_type = Regexp.last_match[:k_type]
315
+ v_type = Regexp.last_match[:v_type]
316
+ {}.tap do |hash|
317
+ value.each do |k, v|
318
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
319
+ end
320
+ end
321
+ else # model
322
+ _model = Object.const_get("PureCloud").const_get(type).new
323
+ _model.build_from_hash(value)
324
+ end
325
+ end
326
+
327
+ def to_s
328
+ to_hash.to_s
329
+ end
330
+
331
+ # to_body is an alias to to_body (backward compatibility))
332
+ def to_body
333
+ to_hash
334
+ end
335
+
336
+ # return the object in the form of hash
337
+ def to_hash
338
+ hash = {}
339
+ self.class.attribute_map.each_pair do |attr, param|
340
+ value = self.send(attr)
341
+ next if value.nil?
342
+ hash[param] = _to_hash(value)
343
+ end
344
+ hash
345
+ end
346
+
347
+ # Method to output non-array value in the form of hash
348
+ # For object, use to_hash. Otherwise, just return the value
349
+ def _to_hash(value)
350
+ if value.is_a?(Array)
351
+ value.compact.map{ |v| _to_hash(v) }
352
+ elsif value.is_a?(Hash)
353
+ {}.tap do |hash|
354
+ value.each { |k, v| hash[k] = _to_hash(v) }
355
+ end
356
+ elsif value.respond_to? :to_hash
357
+ value.to_hash
358
+ else
359
+ value
360
+ end
361
+ end
362
+
363
+ end
364
+ end
@@ -53,6 +53,15 @@ module PureCloud
53
53
  # The source provider for the message.
54
54
  attr_accessor :provider
55
55
 
56
+ # Indicates the type of message platform from which the message originated.
57
+ attr_accessor :type
58
+
59
+ # Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format.
60
+ attr_accessor :recipient_country
61
+
62
+ # The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type.
63
+ attr_accessor :recipient_type
64
+
56
65
  # The UUID of the script to use.
57
66
  attr_accessor :script_id
58
67
 
@@ -96,6 +105,12 @@ module PureCloud
96
105
 
97
106
  :'provider' => :'provider',
98
107
 
108
+ :'type' => :'type',
109
+
110
+ :'recipient_country' => :'recipientCountry',
111
+
112
+ :'recipient_type' => :'recipientType',
113
+
99
114
  :'script_id' => :'scriptId',
100
115
 
101
116
  :'peer_id' => :'peerId',
@@ -137,6 +152,12 @@ module PureCloud
137
152
 
138
153
  :'provider' => :'String',
139
154
 
155
+ :'type' => :'String',
156
+
157
+ :'recipient_country' => :'String',
158
+
159
+ :'recipient_type' => :'String',
160
+
140
161
  :'script_id' => :'String',
141
162
 
142
163
  :'peer_id' => :'String',
@@ -269,6 +290,33 @@ module PureCloud
269
290
  end
270
291
 
271
292
 
293
+ if attributes.has_key?(:'type')
294
+
295
+
296
+ self.type = attributes[:'type']
297
+
298
+
299
+ end
300
+
301
+
302
+ if attributes.has_key?(:'recipientCountry')
303
+
304
+
305
+ self.recipient_country = attributes[:'recipientCountry']
306
+
307
+
308
+ end
309
+
310
+
311
+ if attributes.has_key?(:'recipientType')
312
+
313
+
314
+ self.recipient_type = attributes[:'recipientType']
315
+
316
+
317
+ end
318
+
319
+
272
320
  if attributes.has_key?(:'scriptId')
273
321
 
274
322
 
@@ -393,6 +441,23 @@ module PureCloud
393
441
 
394
442
 
395
443
 
444
+
445
+
446
+
447
+ allowed_values = ["sms"]
448
+ if @type && !allowed_values.include?(@type)
449
+ return false
450
+ end
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
396
461
 
397
462
 
398
463
 
@@ -505,6 +570,30 @@ module PureCloud
505
570
 
506
571
 
507
572
 
573
+ # Custom attribute writer method checking allowed values (enum).
574
+ # @param [Object] type Object to be assigned
575
+ def type=(type)
576
+ allowed_values = ["sms"]
577
+ if type && !allowed_values.include?(type)
578
+ fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
579
+ end
580
+ @type = type
581
+ end
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
508
597
 
509
598
 
510
599
 
@@ -546,6 +635,9 @@ module PureCloud
546
635
  connected_time == o.connected_time &&
547
636
  disconnected_time == o.disconnected_time &&
548
637
  provider == o.provider &&
638
+ type == o.type &&
639
+ recipient_country == o.recipient_country &&
640
+ recipient_type == o.recipient_type &&
549
641
  script_id == o.script_id &&
550
642
  peer_id == o.peer_id &&
551
643
  to_address == o.to_address &&
@@ -562,7 +654,7 @@ module PureCloud
562
654
  # Calculates hash code according to all attributes.
563
655
  # @return [Fixnum] Hash code
564
656
  def hash
565
- [state, id, held, segments, direction, recording_id, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, provider, script_id, peer_id, to_address, from_address, messages].hash
657
+ [state, id, held, segments, direction, recording_id, error_info, disconnect_type, start_hold_time, connected_time, disconnected_time, provider, type, recipient_country, recipient_type, script_id, peer_id, to_address, from_address, messages].hash
566
658
  end
567
659
 
568
660
  # build the object from hash