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
@@ -57,6 +57,12 @@ module PureCloud
57
57
  # Specify INBOUND to create an inbound email conversation to route to a queue, or OUTBOUND to send an email on behalf of a queue.
58
58
  attr_accessor :direction
59
59
 
60
+ # An HTML body content of the email.
61
+ attr_accessor :html_body
62
+
63
+ # A text body content of the email.
64
+ attr_accessor :text_body
65
+
60
66
  # Attribute mapping from ruby-style variable name to JSON key.
61
67
  def self.attribute_map
62
68
  {
@@ -85,7 +91,11 @@ module PureCloud
85
91
 
86
92
  :'subject' => :'subject',
87
93
 
88
- :'direction' => :'direction'
94
+ :'direction' => :'direction',
95
+
96
+ :'html_body' => :'htmlBody',
97
+
98
+ :'text_body' => :'textBody'
89
99
 
90
100
  }
91
101
  end
@@ -118,7 +128,11 @@ module PureCloud
118
128
 
119
129
  :'subject' => :'String',
120
130
 
121
- :'direction' => :'String'
131
+ :'direction' => :'String',
132
+
133
+ :'html_body' => :'String',
134
+
135
+ :'text_body' => :'String'
122
136
 
123
137
  }
124
138
  end
@@ -253,6 +267,24 @@ module PureCloud
253
267
  end
254
268
 
255
269
 
270
+ if attributes.has_key?(:'htmlBody')
271
+
272
+
273
+ self.html_body = attributes[:'htmlBody']
274
+
275
+
276
+ end
277
+
278
+
279
+ if attributes.has_key?(:'textBody')
280
+
281
+
282
+ self.text_body = attributes[:'textBody']
283
+
284
+
285
+ end
286
+
287
+
256
288
  end
257
289
 
258
290
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -330,6 +362,14 @@ module PureCloud
330
362
 
331
363
 
332
364
 
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
333
373
  end
334
374
 
335
375
 
@@ -407,6 +447,16 @@ module PureCloud
407
447
 
408
448
 
409
449
 
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
410
460
  # Checks equality by comparing each attribute.
411
461
  # @param [Object] Object to be compared
412
462
  def ==(o)
@@ -424,7 +474,9 @@ module PureCloud
424
474
  from_address == o.from_address &&
425
475
  from_name == o.from_name &&
426
476
  subject == o.subject &&
427
- direction == o.direction
477
+ direction == o.direction &&
478
+ html_body == o.html_body &&
479
+ text_body == o.text_body
428
480
  end
429
481
 
430
482
  # @see the `==` method
@@ -436,7 +488,7 @@ module PureCloud
436
488
  # Calculates hash code according to all attributes.
437
489
  # @return [Fixnum] Hash code
438
490
  def hash
439
- [queue_id, flow_id, provider, skill_ids, language_id, priority, attributes, to_address, to_name, from_address, from_name, subject, direction].hash
491
+ [queue_id, flow_id, provider, skill_ids, language_id, priority, attributes, to_address, to_name, from_address, from_name, subject, direction, html_body, text_body].hash
440
492
  end
441
493
 
442
494
  # build the object from hash
@@ -65,6 +65,12 @@ module PureCloud
65
65
  # The in-queue flow to use for conversations waiting in queue.
66
66
  attr_accessor :queue_flow
67
67
 
68
+ # The prompt used for whisper audio on the queue, if configured.
69
+ attr_accessor :whisper
70
+
71
+ # Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered.
72
+ attr_accessor :auto_answer_only
73
+
68
74
  # The name to use for caller identification for outbound calls from this queue.
69
75
  attr_accessor :calling_party_name
70
76
 
@@ -120,6 +126,10 @@ module PureCloud
120
126
 
121
127
  :'queue_flow' => :'queueFlow',
122
128
 
129
+ :'whisper' => :'whisper',
130
+
131
+ :'auto_answer_only' => :'autoAnswerOnly',
132
+
123
133
  :'calling_party_name' => :'callingPartyName',
124
134
 
125
135
  :'calling_party_number' => :'callingPartyNumber',
@@ -173,6 +183,10 @@ module PureCloud
173
183
 
174
184
  :'queue_flow' => :'UriReference',
175
185
 
186
+ :'whisper' => :'UriReference',
187
+
188
+ :'auto_answer_only' => :'BOOLEAN',
189
+
176
190
  :'calling_party_name' => :'String',
177
191
 
178
192
  :'calling_party_number' => :'String',
@@ -345,6 +359,24 @@ module PureCloud
345
359
  end
346
360
 
347
361
 
362
+ if attributes.has_key?(:'whisper')
363
+
364
+
365
+ self.whisper = attributes[:'whisper']
366
+
367
+
368
+ end
369
+
370
+
371
+ if attributes.has_key?(:'autoAnswerOnly')
372
+
373
+
374
+ self.auto_answer_only = attributes[:'autoAnswerOnly']
375
+
376
+
377
+ end
378
+
379
+
348
380
  if attributes.has_key?(:'callingPartyName')
349
381
 
350
382
 
@@ -533,6 +565,14 @@ module PureCloud
533
565
 
534
566
 
535
567
 
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
536
576
 
537
577
 
538
578
 
@@ -667,6 +707,16 @@ module PureCloud
667
707
 
668
708
 
669
709
 
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
670
720
 
671
721
 
672
722
 
@@ -699,6 +749,8 @@ module PureCloud
699
749
  acw_settings == o.acw_settings &&
700
750
  skill_evaluation_method == o.skill_evaluation_method &&
701
751
  queue_flow == o.queue_flow &&
752
+ whisper == o.whisper &&
753
+ auto_answer_only == o.auto_answer_only &&
702
754
  calling_party_name == o.calling_party_name &&
703
755
  calling_party_number == o.calling_party_number &&
704
756
  default_scripts == o.default_scripts &&
@@ -717,7 +769,7 @@ module PureCloud
717
769
  # Calculates hash code according to all attributes.
718
770
  # @return [Fixnum] Hash code
719
771
  def hash
720
- [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, default_scripts, outbound_email_address, source_queue_id, member_count, self_uri].hash
772
+ [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper, auto_answer_only, calling_party_name, calling_party_number, default_scripts, outbound_email_address, source_queue_id, member_count, self_uri].hash
721
773
  end
722
774
 
723
775
  # build the object from hash
@@ -0,0 +1,290 @@
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 CreateSecureSession
21
+ # requesting participant
22
+ attr_accessor :source_participant_id
23
+
24
+ # the flow id to execute in the secure session
25
+ attr_accessor :flow_id
26
+
27
+ # user data for the secure session
28
+ attr_accessor :user_data
29
+
30
+ # if true, disconnect the agent after creating the session
31
+ attr_accessor :disconnect
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+
37
+ :'source_participant_id' => :'sourceParticipantId',
38
+
39
+ :'flow_id' => :'flowId',
40
+
41
+ :'user_data' => :'userData',
42
+
43
+ :'disconnect' => :'disconnect'
44
+
45
+ }
46
+ end
47
+
48
+ # Attribute type mapping.
49
+ def self.swagger_types
50
+ {
51
+
52
+ :'source_participant_id' => :'String',
53
+
54
+ :'flow_id' => :'String',
55
+
56
+ :'user_data' => :'String',
57
+
58
+ :'disconnect' => :'BOOLEAN'
59
+
60
+ }
61
+ end
62
+
63
+ # Initializes the object
64
+ # @param [Hash] attributes Model attributes in the form of hash
65
+ def initialize(attributes = {})
66
+ return unless attributes.is_a?(Hash)
67
+
68
+ # convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
70
+
71
+
72
+ if attributes.has_key?(:'sourceParticipantId')
73
+
74
+
75
+ self.source_participant_id = attributes[:'sourceParticipantId']
76
+
77
+
78
+ end
79
+
80
+
81
+ if attributes.has_key?(:'flowId')
82
+
83
+
84
+ self.flow_id = attributes[:'flowId']
85
+
86
+
87
+ end
88
+
89
+
90
+ if attributes.has_key?(:'userData')
91
+
92
+
93
+ self.user_data = attributes[:'userData']
94
+
95
+
96
+ end
97
+
98
+
99
+ if attributes.has_key?(:'disconnect')
100
+
101
+
102
+ self.disconnect = attributes[:'disconnect']
103
+
104
+
105
+ end
106
+
107
+
108
+ end
109
+
110
+ # Show invalid properties with the reasons. Usually used together with valid?
111
+ # @return Array for valid properies with the reasons
112
+ def list_invalid_properties
113
+ invalid_properties = Array.new
114
+
115
+
116
+ return invalid_properties
117
+ end
118
+
119
+ # Check to see if the all the properties in the model are valid
120
+ # @return true if the model is valid
121
+ def valid?
122
+
123
+
124
+
125
+
126
+
127
+
128
+ if @flow_id.nil?
129
+ return false
130
+ end
131
+
132
+
133
+
134
+
135
+
136
+
137
+ if @user_data.nil?
138
+ return false
139
+ end
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+ end
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ # Checks equality by comparing each attribute.
173
+ # @param [Object] Object to be compared
174
+ def ==(o)
175
+ return true if self.equal?(o)
176
+ self.class == o.class &&
177
+ source_participant_id == o.source_participant_id &&
178
+ flow_id == o.flow_id &&
179
+ user_data == o.user_data &&
180
+ disconnect == o.disconnect
181
+ end
182
+
183
+ # @see the `==` method
184
+ # @param [Object] Object to be compared
185
+ def eql?(o)
186
+ self == o
187
+ end
188
+
189
+ # Calculates hash code according to all attributes.
190
+ # @return [Fixnum] Hash code
191
+ def hash
192
+ [source_participant_id, flow_id, user_data, disconnect].hash
193
+ end
194
+
195
+ # build the object from hash
196
+ def build_from_hash(attributes)
197
+ return nil unless attributes.is_a?(Hash)
198
+ self.class.swagger_types.each_pair do |key, type|
199
+ if type =~ /^Array<(.*)>/i
200
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
201
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
202
+ else
203
+ #TODO show warning in debug mode
204
+ end
205
+ elsif !attributes[self.class.attribute_map[key]].nil?
206
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
207
+ else
208
+ # data not found in attributes(hash), not an issue as the data can be optional
209
+ end
210
+ end
211
+
212
+ self
213
+ end
214
+
215
+ def _deserialize(type, value)
216
+ case type.to_sym
217
+ when :DateTime
218
+ DateTime.parse(value)
219
+ when :Date
220
+ Date.parse(value)
221
+ when :String
222
+ value.to_s
223
+ when :Integer
224
+ value.to_i
225
+ when :Float
226
+ value.to_f
227
+ when :BOOLEAN
228
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
229
+ true
230
+ else
231
+ false
232
+ end
233
+ when :Object
234
+ # generic object (usually a Hash), return directly
235
+ value
236
+ when /\AArray<(?<inner_type>.+)>\z/
237
+ inner_type = Regexp.last_match[:inner_type]
238
+ value.map { |v| _deserialize(inner_type, v) }
239
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
240
+ k_type = Regexp.last_match[:k_type]
241
+ v_type = Regexp.last_match[:v_type]
242
+ {}.tap do |hash|
243
+ value.each do |k, v|
244
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
245
+ end
246
+ end
247
+ else # model
248
+ _model = Object.const_get("PureCloud").const_get(type).new
249
+ _model.build_from_hash(value)
250
+ end
251
+ end
252
+
253
+ def to_s
254
+ to_hash.to_s
255
+ end
256
+
257
+ # to_body is an alias to to_body (backward compatibility))
258
+ def to_body
259
+ to_hash
260
+ end
261
+
262
+ # return the object in the form of hash
263
+ def to_hash
264
+ hash = {}
265
+ self.class.attribute_map.each_pair do |attr, param|
266
+ value = self.send(attr)
267
+ next if value.nil?
268
+ hash[param] = _to_hash(value)
269
+ end
270
+ hash
271
+ end
272
+
273
+ # Method to output non-array value in the form of hash
274
+ # For object, use to_hash. Otherwise, just return the value
275
+ def _to_hash(value)
276
+ if value.is_a?(Array)
277
+ value.compact.map{ |v| _to_hash(v) }
278
+ elsif value.is_a?(Hash)
279
+ {}.tap do |hash|
280
+ value.each { |k, v| hash[k] = _to_hash(v) }
281
+ end
282
+ elsif value.respond_to? :to_hash
283
+ value.to_hash
284
+ else
285
+ value
286
+ end
287
+ end
288
+
289
+ end
290
+ end