purecloudplatformclientv2 20.0.0 → 21.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.
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
@@ -28,7 +28,7 @@ module PureCloud
28
28
 
29
29
  attr_accessor :type
30
30
 
31
- # Use extension instead of address for setting internal extensions
31
+ # Use internal extension instead of address. Mutually exclusive with the address field.
32
32
  attr_accessor :extension
33
33
 
34
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -46,6 +46,12 @@ module PureCloud
46
46
 
47
47
  attr_accessor :messages_transcript_uri
48
48
 
49
+ attr_accessor :type
50
+
51
+ attr_accessor :recipient_country
52
+
53
+ attr_accessor :recipient_type
54
+
49
55
  attr_accessor :additional_properties
50
56
 
51
57
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -80,6 +86,12 @@ module PureCloud
80
86
 
81
87
  :'messages_transcript_uri' => :'messagesTranscriptUri',
82
88
 
89
+ :'type' => :'type',
90
+
91
+ :'recipient_country' => :'recipientCountry',
92
+
93
+ :'recipient_type' => :'recipientType',
94
+
83
95
  :'additional_properties' => :'additionalProperties'
84
96
 
85
97
  }
@@ -117,6 +129,12 @@ module PureCloud
117
129
 
118
130
  :'messages_transcript_uri' => :'String',
119
131
 
132
+ :'type' => :'String',
133
+
134
+ :'recipient_country' => :'String',
135
+
136
+ :'recipient_type' => :'String',
137
+
120
138
  :'additional_properties' => :'Object'
121
139
 
122
140
  }
@@ -259,6 +277,33 @@ module PureCloud
259
277
  end
260
278
 
261
279
 
280
+ if attributes.has_key?(:'type')
281
+
282
+
283
+ self.type = attributes[:'type']
284
+
285
+
286
+ end
287
+
288
+
289
+ if attributes.has_key?(:'recipientCountry')
290
+
291
+
292
+ self.recipient_country = attributes[:'recipientCountry']
293
+
294
+
295
+ end
296
+
297
+
298
+ if attributes.has_key?(:'recipientType')
299
+
300
+
301
+ self.recipient_type = attributes[:'recipientType']
302
+
303
+
304
+ end
305
+
306
+
262
307
  if attributes.has_key?(:'additionalProperties')
263
308
 
264
309
 
@@ -338,6 +383,23 @@ module PureCloud
338
383
 
339
384
 
340
385
 
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+ allowed_values = ["SMS"]
400
+ if @type && !allowed_values.include?(@type)
401
+ return false
402
+ end
341
403
 
342
404
 
343
405
 
@@ -431,6 +493,30 @@ module PureCloud
431
493
 
432
494
 
433
495
 
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+ # Custom attribute writer method checking allowed values (enum).
511
+ # @param [Object] type Object to be assigned
512
+ def type=(type)
513
+ allowed_values = ["SMS"]
514
+ if type && !allowed_values.include?(type)
515
+ fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
516
+ end
517
+ @type = type
518
+ end
519
+
434
520
 
435
521
 
436
522
 
@@ -468,6 +554,9 @@ module PureCloud
468
554
  from_address == o.from_address &&
469
555
  messages == o.messages &&
470
556
  messages_transcript_uri == o.messages_transcript_uri &&
557
+ type == o.type &&
558
+ recipient_country == o.recipient_country &&
559
+ recipient_type == o.recipient_type &&
471
560
  additional_properties == o.additional_properties
472
561
  end
473
562
 
@@ -480,7 +569,7 @@ module PureCloud
480
569
  # Calculates hash code according to all attributes.
481
570
  # @return [Fixnum] Hash code
482
571
  def hash
483
- [id, state, held, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, additional_properties].hash
572
+ [id, state, held, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, type, recipient_country, recipient_type, additional_properties].hash
484
573
  end
485
574
 
486
575
  # build the object from hash
@@ -22,13 +22,21 @@ module PureCloud
22
22
 
23
23
  attr_accessor :message_time
24
24
 
25
+ attr_accessor :message_status
26
+
27
+ attr_accessor :message_segment_count
28
+
25
29
  # Attribute mapping from ruby-style variable name to JSON key.
26
30
  def self.attribute_map
27
31
  {
28
32
 
29
33
  :'message_id' => :'messageId',
30
34
 
31
- :'message_time' => :'messageTime'
35
+ :'message_time' => :'messageTime',
36
+
37
+ :'message_status' => :'messageStatus',
38
+
39
+ :'message_segment_count' => :'messageSegmentCount'
32
40
 
33
41
  }
34
42
  end
@@ -39,7 +47,11 @@ module PureCloud
39
47
 
40
48
  :'message_id' => :'String',
41
49
 
42
- :'message_time' => :'DateTime'
50
+ :'message_time' => :'DateTime',
51
+
52
+ :'message_status' => :'String',
53
+
54
+ :'message_segment_count' => :'Integer'
43
55
 
44
56
  }
45
57
  end
@@ -71,6 +83,24 @@ module PureCloud
71
83
  end
72
84
 
73
85
 
86
+ if attributes.has_key?(:'messageStatus')
87
+
88
+
89
+ self.message_status = attributes[:'messageStatus']
90
+
91
+
92
+ end
93
+
94
+
95
+ if attributes.has_key?(:'messageSegmentCount')
96
+
97
+
98
+ self.message_segment_count = attributes[:'messageSegmentCount']
99
+
100
+
101
+ end
102
+
103
+
74
104
  end
75
105
 
76
106
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,6 +124,19 @@ module PureCloud
94
124
 
95
125
 
96
126
 
127
+
128
+
129
+ allowed_values = ["QUEUED", "SENT", "FAILED", "RECEIVED"]
130
+ if @message_status && !allowed_values.include?(@message_status)
131
+ return false
132
+ end
133
+
134
+
135
+
136
+
137
+
138
+
139
+
97
140
  end
98
141
 
99
142
 
@@ -107,13 +150,34 @@ module PureCloud
107
150
 
108
151
 
109
152
 
153
+
154
+ # Custom attribute writer method checking allowed values (enum).
155
+ # @param [Object] message_status Object to be assigned
156
+ def message_status=(message_status)
157
+ allowed_values = ["QUEUED", "SENT", "FAILED", "RECEIVED"]
158
+ if message_status && !allowed_values.include?(message_status)
159
+ fail ArgumentError, "invalid value for 'message_status', must be one of #{allowed_values}."
160
+ end
161
+ @message_status = message_status
162
+ end
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
110
172
  # Checks equality by comparing each attribute.
111
173
  # @param [Object] Object to be compared
112
174
  def ==(o)
113
175
  return true if self.equal?(o)
114
176
  self.class == o.class &&
115
177
  message_id == o.message_id &&
116
- message_time == o.message_time
178
+ message_time == o.message_time &&
179
+ message_status == o.message_status &&
180
+ message_segment_count == o.message_segment_count
117
181
  end
118
182
 
119
183
  # @see the `==` method
@@ -125,7 +189,7 @@ module PureCloud
125
189
  # Calculates hash code according to all attributes.
126
190
  # @return [Fixnum] Hash code
127
191
  def hash
128
- [message_id, message_time].hash
192
+ [message_id, message_time, message_status, message_segment_count].hash
129
193
  end
130
194
 
131
195
  # build the object from hash
@@ -22,13 +22,21 @@ module PureCloud
22
22
 
23
23
  attr_accessor :message_time
24
24
 
25
+ attr_accessor :message_status
26
+
27
+ attr_accessor :message_segment_count
28
+
25
29
  # Attribute mapping from ruby-style variable name to JSON key.
26
30
  def self.attribute_map
27
31
  {
28
32
 
29
33
  :'message_id' => :'messageId',
30
34
 
31
- :'message_time' => :'messageTime'
35
+ :'message_time' => :'messageTime',
36
+
37
+ :'message_status' => :'messageStatus',
38
+
39
+ :'message_segment_count' => :'messageSegmentCount'
32
40
 
33
41
  }
34
42
  end
@@ -39,7 +47,11 @@ module PureCloud
39
47
 
40
48
  :'message_id' => :'String',
41
49
 
42
- :'message_time' => :'DateTime'
50
+ :'message_time' => :'DateTime',
51
+
52
+ :'message_status' => :'String',
53
+
54
+ :'message_segment_count' => :'Integer'
43
55
 
44
56
  }
45
57
  end
@@ -71,6 +83,24 @@ module PureCloud
71
83
  end
72
84
 
73
85
 
86
+ if attributes.has_key?(:'messageStatus')
87
+
88
+
89
+ self.message_status = attributes[:'messageStatus']
90
+
91
+
92
+ end
93
+
94
+
95
+ if attributes.has_key?(:'messageSegmentCount')
96
+
97
+
98
+ self.message_segment_count = attributes[:'messageSegmentCount']
99
+
100
+
101
+ end
102
+
103
+
74
104
  end
75
105
 
76
106
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,6 +124,19 @@ module PureCloud
94
124
 
95
125
 
96
126
 
127
+
128
+
129
+ allowed_values = ["QUEUED", "SENT", "FAILED", "RECEIVED"]
130
+ if @message_status && !allowed_values.include?(@message_status)
131
+ return false
132
+ end
133
+
134
+
135
+
136
+
137
+
138
+
139
+
97
140
  end
98
141
 
99
142
 
@@ -107,13 +150,34 @@ module PureCloud
107
150
 
108
151
 
109
152
 
153
+
154
+ # Custom attribute writer method checking allowed values (enum).
155
+ # @param [Object] message_status Object to be assigned
156
+ def message_status=(message_status)
157
+ allowed_values = ["QUEUED", "SENT", "FAILED", "RECEIVED"]
158
+ if message_status && !allowed_values.include?(message_status)
159
+ fail ArgumentError, "invalid value for 'message_status', must be one of #{allowed_values}."
160
+ end
161
+ @message_status = message_status
162
+ end
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
110
172
  # Checks equality by comparing each attribute.
111
173
  # @param [Object] Object to be compared
112
174
  def ==(o)
113
175
  return true if self.equal?(o)
114
176
  self.class == o.class &&
115
177
  message_id == o.message_id &&
116
- message_time == o.message_time
178
+ message_time == o.message_time &&
179
+ message_status == o.message_status &&
180
+ message_segment_count == o.message_segment_count
117
181
  end
118
182
 
119
183
  # @see the `==` method
@@ -125,7 +189,7 @@ module PureCloud
125
189
  # Calculates hash code according to all attributes.
126
190
  # @return [Fixnum] Hash code
127
191
  def hash
128
- [message_id, message_time].hash
192
+ [message_id, message_time, message_status, message_segment_count].hash
129
193
  end
130
194
 
131
195
  # build the object from hash
@@ -46,6 +46,12 @@ module PureCloud
46
46
 
47
47
  attr_accessor :messages_transcript_uri
48
48
 
49
+ attr_accessor :type
50
+
51
+ attr_accessor :recipient_country
52
+
53
+ attr_accessor :recipient_type
54
+
49
55
  attr_accessor :additional_properties
50
56
 
51
57
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -80,6 +86,12 @@ module PureCloud
80
86
 
81
87
  :'messages_transcript_uri' => :'messagesTranscriptUri',
82
88
 
89
+ :'type' => :'type',
90
+
91
+ :'recipient_country' => :'recipientCountry',
92
+
93
+ :'recipient_type' => :'recipientType',
94
+
83
95
  :'additional_properties' => :'additionalProperties'
84
96
 
85
97
  }
@@ -117,6 +129,12 @@ module PureCloud
117
129
 
118
130
  :'messages_transcript_uri' => :'String',
119
131
 
132
+ :'type' => :'String',
133
+
134
+ :'recipient_country' => :'String',
135
+
136
+ :'recipient_type' => :'String',
137
+
120
138
  :'additional_properties' => :'Object'
121
139
 
122
140
  }
@@ -259,6 +277,33 @@ module PureCloud
259
277
  end
260
278
 
261
279
 
280
+ if attributes.has_key?(:'type')
281
+
282
+
283
+ self.type = attributes[:'type']
284
+
285
+
286
+ end
287
+
288
+
289
+ if attributes.has_key?(:'recipientCountry')
290
+
291
+
292
+ self.recipient_country = attributes[:'recipientCountry']
293
+
294
+
295
+ end
296
+
297
+
298
+ if attributes.has_key?(:'recipientType')
299
+
300
+
301
+ self.recipient_type = attributes[:'recipientType']
302
+
303
+
304
+ end
305
+
306
+
262
307
  if attributes.has_key?(:'additionalProperties')
263
308
 
264
309
 
@@ -338,6 +383,23 @@ module PureCloud
338
383
 
339
384
 
340
385
 
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+ allowed_values = ["SMS"]
400
+ if @type && !allowed_values.include?(@type)
401
+ return false
402
+ end
341
403
 
342
404
 
343
405
 
@@ -431,6 +493,30 @@ module PureCloud
431
493
 
432
494
 
433
495
 
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+ # Custom attribute writer method checking allowed values (enum).
511
+ # @param [Object] type Object to be assigned
512
+ def type=(type)
513
+ allowed_values = ["SMS"]
514
+ if type && !allowed_values.include?(type)
515
+ fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
516
+ end
517
+ @type = type
518
+ end
519
+
434
520
 
435
521
 
436
522
 
@@ -468,6 +554,9 @@ module PureCloud
468
554
  from_address == o.from_address &&
469
555
  messages == o.messages &&
470
556
  messages_transcript_uri == o.messages_transcript_uri &&
557
+ type == o.type &&
558
+ recipient_country == o.recipient_country &&
559
+ recipient_type == o.recipient_type &&
471
560
  additional_properties == o.additional_properties
472
561
  end
473
562
 
@@ -480,7 +569,7 @@ module PureCloud
480
569
  # Calculates hash code according to all attributes.
481
570
  # @return [Fixnum] Hash code
482
571
  def hash
483
- [id, state, held, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, additional_properties].hash
572
+ [id, state, held, provider, script_id, peer_id, disconnect_type, start_hold_time, connected_time, disconnected_time, to_address, from_address, messages, messages_transcript_uri, type, recipient_country, recipient_type, additional_properties].hash
484
573
  end
485
574
 
486
575
  # build the object from hash