purecloudplatformclientv2 44.0.0 → 45.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 (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/AnalyticsSurvey.md +2 -1
  6. data/docs/ArchitectApi.md +52 -127
  7. data/docs/ContactListDivisionView.md +20 -0
  8. data/docs/ContactListDivisionViewListing.md +22 -0
  9. data/docs/ContactListNotification.md +1 -0
  10. data/docs/ConversationQuery.md +1 -1
  11. data/docs/CreateOutboundMessagingConversationRequest.md +1 -1
  12. data/docs/CreateWorkPlan.md +2 -0
  13. data/docs/CustomerInteractionCenter.md +1 -1
  14. data/docs/DataExportNotificationNotification.md +1 -0
  15. data/docs/DncListNotification.md +1 -0
  16. data/docs/DncListNotificationUriReference.md +14 -0
  17. data/docs/GSuite.md +1 -1
  18. data/docs/HelpLink.md +15 -0
  19. data/docs/IdentityNow.md +1 -1
  20. data/docs/IntegrationType.md +8 -0
  21. data/docs/IntradayDataUpdateNotification.md +2 -2
  22. data/docs/Okta.md +1 -1
  23. data/docs/OneLogin.md +1 -1
  24. data/docs/OutboundApi.md +152 -0
  25. data/docs/PingIdentity.md +1 -1
  26. data/docs/QualityApi.md +66 -0
  27. data/docs/ReportingExportJobResponse.md +1 -0
  28. data/docs/RoutingApi.md +74 -0
  29. data/docs/Salesforce.md +1 -1
  30. data/docs/UserScheduleAdherenceUpdateNotification.md +2 -2
  31. data/docs/WfmAgentScheduleUpdateNotificationNotification.md +18 -0
  32. data/docs/WfmAgentScheduleUpdateNotificationNotificationActivities.md +18 -0
  33. data/docs/WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers.md +19 -0
  34. data/docs/WfmAgentScheduleUpdateNotificationNotificationShifts.md +15 -0
  35. data/docs/WfmAgentScheduleUpdateNotificationNotificationUpdates.md +14 -0
  36. data/docs/WfmAgentScheduleUpdateNotificationNotificationUserReference.md +13 -0
  37. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate.md +14 -0
  38. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker.md +19 -0
  39. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity.md +18 -0
  40. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift.md +15 -0
  41. data/docs/WfmScheduleNotificationNotification.md +1 -0
  42. data/docs/WorkPlan.md +2 -0
  43. data/docs/WorkPlanListItemResponse.md +16 -5
  44. data/docs/WorkforceManagementApi.md +2 -2
  45. data/lib/purecloudplatformclientv2.rb +14 -3
  46. data/lib/purecloudplatformclientv2/api/outbound_api.rb +230 -0
  47. data/lib/purecloudplatformclientv2/api/quality_api.rb +66 -0
  48. data/lib/purecloudplatformclientv2/api/routing_api.rb +100 -0
  49. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -7
  50. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  51. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  52. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  53. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +2 -2
  54. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  55. data/lib/purecloudplatformclientv2/models/analytics_survey.rb +34 -8
  56. data/lib/purecloudplatformclientv2/models/contact_list_division_view.rb +397 -0
  57. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +428 -0
  58. data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +26 -1
  59. data/lib/purecloudplatformclientv2/models/conversation_query.rb +1 -1
  60. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +1 -1
  61. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +53 -1
  62. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  63. data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +31 -6
  64. data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +26 -1
  65. data/lib/purecloudplatformclientv2/models/dnc_list_notification_uri_reference.rb +226 -0
  66. data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
  67. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  68. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_date_time.rb → help_link.rb} +24 -45
  69. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  70. data/lib/purecloudplatformclientv2/models/integration_type.rb +211 -1
  71. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +2 -2
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +2 -2
  74. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  75. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  76. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  77. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +34 -3
  78. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  79. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +2 -2
  80. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification.rb +332 -0
  81. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_activities.rb +326 -0
  82. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_full_day_time_off_markers.rb +351 -0
  83. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_start_date.rb → wfm_agent_schedule_update_notification_notification_shifts.rb} +22 -45
  84. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_updates.rb +242 -0
  85. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_user_reference.rb +201 -0
  86. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_agent_schedule_update.rb +242 -0
  87. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_full_day_time_off_marker.rb +351 -0
  88. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_activity.rb +326 -0
  89. data/lib/purecloudplatformclientv2/models/{user_schedule_adherence_update_notification_date_time.rb → wfm_agent_schedule_update_notification_notification_wfm_schedule_shift.rb} +22 -45
  90. data/lib/purecloudplatformclientv2/models/wfm_schedule_notification_notification.rb +28 -3
  91. data/lib/purecloudplatformclientv2/models/work_plan.rb +53 -1
  92. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +313 -18
  93. data/lib/purecloudplatformclientv2/version.rb +1 -1
  94. metadata +30 -8
  95. data/docs/IntradayDataUpdateNotificationDateTime.md +0 -16
  96. data/docs/IntradayDataUpdateNotificationStartDate.md +0 -16
  97. data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +0 -16
@@ -0,0 +1,226 @@
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 DncListNotificationUriReference
21
+ attr_accessor :id
22
+
23
+ attr_accessor :name
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+
29
+ :'id' => :'id',
30
+
31
+ :'name' => :'name'
32
+
33
+ }
34
+ end
35
+
36
+ # Attribute type mapping.
37
+ def self.swagger_types
38
+ {
39
+
40
+ :'id' => :'String',
41
+
42
+ :'name' => :'String'
43
+
44
+ }
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ return unless attributes.is_a?(Hash)
51
+
52
+ # convert string to symbol for hash key
53
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
54
+
55
+
56
+ if attributes.has_key?(:'id')
57
+
58
+
59
+ self.id = attributes[:'id']
60
+
61
+
62
+ end
63
+
64
+
65
+ if attributes.has_key?(:'name')
66
+
67
+
68
+ self.name = attributes[:'name']
69
+
70
+
71
+ end
72
+
73
+
74
+ end
75
+
76
+ # Show invalid properties with the reasons. Usually used together with valid?
77
+ # @return Array for valid properies with the reasons
78
+ def list_invalid_properties
79
+ invalid_properties = Array.new
80
+
81
+
82
+ return invalid_properties
83
+ end
84
+
85
+ # Check to see if the all the properties in the model are valid
86
+ # @return true if the model is valid
87
+ def valid?
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ end
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ # Checks equality by comparing each attribute.
111
+ # @param [Object] Object to be compared
112
+ def ==(o)
113
+ return true if self.equal?(o)
114
+ self.class == o.class &&
115
+ id == o.id &&
116
+ name == o.name
117
+ end
118
+
119
+ # @see the `==` method
120
+ # @param [Object] Object to be compared
121
+ def eql?(o)
122
+ self == o
123
+ end
124
+
125
+ # Calculates hash code according to all attributes.
126
+ # @return [Fixnum] Hash code
127
+ def hash
128
+ [id, name].hash
129
+ end
130
+
131
+ # build the object from hash
132
+ def build_from_hash(attributes)
133
+ return nil unless attributes.is_a?(Hash)
134
+ self.class.swagger_types.each_pair do |key, type|
135
+ if type =~ /^Array<(.*)>/i
136
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
137
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
138
+ else
139
+ #TODO show warning in debug mode
140
+ end
141
+ elsif !attributes[self.class.attribute_map[key]].nil?
142
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
143
+ else
144
+ # data not found in attributes(hash), not an issue as the data can be optional
145
+ end
146
+ end
147
+
148
+ self
149
+ end
150
+
151
+ def _deserialize(type, value)
152
+ case type.to_sym
153
+ when :DateTime
154
+ DateTime.parse(value)
155
+ when :Date
156
+ Date.parse(value)
157
+ when :String
158
+ value.to_s
159
+ when :Integer
160
+ value.to_i
161
+ when :Float
162
+ value.to_f
163
+ when :BOOLEAN
164
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
165
+ true
166
+ else
167
+ false
168
+ end
169
+ when :Object
170
+ # generic object (usually a Hash), return directly
171
+ value
172
+ when /\AArray<(?<inner_type>.+)>\z/
173
+ inner_type = Regexp.last_match[:inner_type]
174
+ value.map { |v| _deserialize(inner_type, v) }
175
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
176
+ k_type = Regexp.last_match[:k_type]
177
+ v_type = Regexp.last_match[:v_type]
178
+ {}.tap do |hash|
179
+ value.each do |k, v|
180
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
181
+ end
182
+ end
183
+ else # model
184
+ _model = Object.const_get("PureCloud").const_get(type).new
185
+ _model.build_from_hash(value)
186
+ end
187
+ end
188
+
189
+ def to_s
190
+ to_hash.to_s
191
+ end
192
+
193
+ # to_body is an alias to to_body (backward compatibility))
194
+ def to_body
195
+ to_hash
196
+ end
197
+
198
+ # return the object in the form of hash
199
+ def to_hash
200
+ hash = {}
201
+ self.class.attribute_map.each_pair do |attr, param|
202
+ value = self.send(attr)
203
+ next if value.nil?
204
+ hash[param] = _to_hash(value)
205
+ end
206
+ hash
207
+ end
208
+
209
+ # Method to output non-array value in the form of hash
210
+ # For object, use to_hash. Otherwise, just return the value
211
+ def _to_hash(value)
212
+ if value.is_a?(Array)
213
+ value.compact.map{ |v| _to_hash(v) }
214
+ elsif value.is_a?(Hash)
215
+ {}.tap do |hash|
216
+ value.each { |k, v| hash[k] = _to_hash(v) }
217
+ end
218
+ elsif value.respond_to? :to_hash
219
+ value.to_hash
220
+ else
221
+ value
222
+ end
223
+ end
224
+
225
+ end
226
+ end
@@ -348,7 +348,7 @@ module PureCloud
348
348
 
349
349
 
350
350
 
351
- allowed_values = ["SUCCESS", "FAILURE"]
351
+ allowed_values = ["SUCCESS", "FAILURE", "WARNING"]
352
352
  if @status && !allowed_values.include?(@status)
353
353
  return false
354
354
  end
@@ -451,7 +451,7 @@ module PureCloud
451
451
  # Custom attribute writer method checking allowed values (enum).
452
452
  # @param [Object] status Object to be assigned
453
453
  def status=(status)
454
- allowed_values = ["SUCCESS", "FAILURE"]
454
+ allowed_values = ["SUCCESS", "FAILURE", "WARNING"]
455
455
  if status && !allowed_values.include?(status)
456
456
  fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
457
457
  end
@@ -27,10 +27,10 @@ module PureCloud
27
27
 
28
28
  attr_accessor :certificate
29
29
 
30
- attr_accessor :issuer_uri
31
-
32
30
  attr_accessor :sso_target_uri
33
31
 
32
+ attr_accessor :issuer_uri
33
+
34
34
  attr_accessor :disabled
35
35
 
36
36
  # The URI for this object
@@ -48,10 +48,10 @@ module PureCloud
48
48
 
49
49
  :'certificate' => :'certificate',
50
50
 
51
- :'issuer_uri' => :'issuerURI',
52
-
53
51
  :'sso_target_uri' => :'ssoTargetURI',
54
52
 
53
+ :'issuer_uri' => :'issuerURI',
54
+
55
55
  :'disabled' => :'disabled',
56
56
 
57
57
  :'self_uri' => :'selfUri'
@@ -71,10 +71,10 @@ module PureCloud
71
71
 
72
72
  :'certificate' => :'String',
73
73
 
74
- :'issuer_uri' => :'String',
75
-
76
74
  :'sso_target_uri' => :'String',
77
75
 
76
+ :'issuer_uri' => :'String',
77
+
78
78
  :'disabled' => :'BOOLEAN',
79
79
 
80
80
  :'self_uri' => :'String'
@@ -127,19 +127,19 @@ module PureCloud
127
127
  end
128
128
 
129
129
 
130
- if attributes.has_key?(:'issuerURI')
130
+ if attributes.has_key?(:'ssoTargetURI')
131
131
 
132
132
 
133
- self.issuer_uri = attributes[:'issuerURI']
133
+ self.sso_target_uri = attributes[:'ssoTargetURI']
134
134
 
135
135
 
136
136
  end
137
137
 
138
138
 
139
- if attributes.has_key?(:'ssoTargetURI')
139
+ if attributes.has_key?(:'issuerURI')
140
140
 
141
141
 
142
- self.sso_target_uri = attributes[:'ssoTargetURI']
142
+ self.issuer_uri = attributes[:'issuerURI']
143
143
 
144
144
 
145
145
  end
@@ -262,8 +262,8 @@ module PureCloud
262
262
  name == o.name &&
263
263
  relying_party_identifier == o.relying_party_identifier &&
264
264
  certificate == o.certificate &&
265
- issuer_uri == o.issuer_uri &&
266
265
  sso_target_uri == o.sso_target_uri &&
266
+ issuer_uri == o.issuer_uri &&
267
267
  disabled == o.disabled &&
268
268
  self_uri == o.self_uri
269
269
  end
@@ -277,7 +277,7 @@ module PureCloud
277
277
  # Calculates hash code according to all attributes.
278
278
  # @return [Fixnum] Hash code
279
279
  def hash
280
- [id, name, relying_party_identifier, certificate, issuer_uri, sso_target_uri, disabled, self_uri].hash
280
+ [id, name, relying_party_identifier, certificate, sso_target_uri, issuer_uri, disabled, self_uri].hash
281
281
  end
282
282
 
283
283
  # build the object from hash
@@ -17,26 +17,26 @@ Terms of Service: https://developer.mypurecloud.com/tos
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- class IntradayDataUpdateNotificationDateTime
21
- attr_accessor :i_millis
20
+ # Link to a help or support resource
21
+ class HelpLink
22
+ # URI of the help resource
23
+ attr_accessor :uri
22
24
 
23
- attr_accessor :before_now
25
+ # Link text of the resource
26
+ attr_accessor :title
24
27
 
25
- attr_accessor :after_now
26
-
27
- attr_accessor :equal_now
28
+ # Description of the document or resource
29
+ attr_accessor :description
28
30
 
29
31
  # Attribute mapping from ruby-style variable name to JSON key.
30
32
  def self.attribute_map
31
33
  {
32
34
 
33
- :'i_millis' => :'iMillis',
34
-
35
- :'before_now' => :'beforeNow',
35
+ :'uri' => :'uri',
36
36
 
37
- :'after_now' => :'afterNow',
37
+ :'title' => :'title',
38
38
 
39
- :'equal_now' => :'equalNow'
39
+ :'description' => :'description'
40
40
 
41
41
  }
42
42
  end
@@ -45,13 +45,11 @@ module PureCloud
45
45
  def self.swagger_types
46
46
  {
47
47
 
48
- :'i_millis' => :'Integer',
49
-
50
- :'before_now' => :'BOOLEAN',
48
+ :'uri' => :'String',
51
49
 
52
- :'after_now' => :'BOOLEAN',
50
+ :'title' => :'String',
53
51
 
54
- :'equal_now' => :'BOOLEAN'
52
+ :'description' => :'String'
55
53
 
56
54
  }
57
55
  end
@@ -65,37 +63,28 @@ module PureCloud
65
63
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
66
64
 
67
65
 
68
- if attributes.has_key?(:'iMillis')
69
-
70
-
71
- self.i_millis = attributes[:'iMillis']
72
-
73
-
74
- end
75
-
76
-
77
- if attributes.has_key?(:'beforeNow')
66
+ if attributes.has_key?(:'uri')
78
67
 
79
68
 
80
- self.before_now = attributes[:'beforeNow']
69
+ self.uri = attributes[:'uri']
81
70
 
82
71
 
83
72
  end
84
73
 
85
74
 
86
- if attributes.has_key?(:'afterNow')
75
+ if attributes.has_key?(:'title')
87
76
 
88
77
 
89
- self.after_now = attributes[:'afterNow']
78
+ self.title = attributes[:'title']
90
79
 
91
80
 
92
81
  end
93
82
 
94
83
 
95
- if attributes.has_key?(:'equalNow')
84
+ if attributes.has_key?(:'description')
96
85
 
97
86
 
98
- self.equal_now = attributes[:'equalNow']
87
+ self.description = attributes[:'description']
99
88
 
100
89
 
101
90
  end
@@ -128,10 +117,6 @@ module PureCloud
128
117
 
129
118
 
130
119
 
131
-
132
-
133
-
134
-
135
120
  end
136
121
 
137
122
 
@@ -148,11 +133,6 @@ module PureCloud
148
133
 
149
134
 
150
135
 
151
-
152
-
153
-
154
-
155
-
156
136
 
157
137
 
158
138
  # Checks equality by comparing each attribute.
@@ -160,10 +140,9 @@ module PureCloud
160
140
  def ==(o)
161
141
  return true if self.equal?(o)
162
142
  self.class == o.class &&
163
- i_millis == o.i_millis &&
164
- before_now == o.before_now &&
165
- after_now == o.after_now &&
166
- equal_now == o.equal_now
143
+ uri == o.uri &&
144
+ title == o.title &&
145
+ description == o.description
167
146
  end
168
147
 
169
148
  # @see the `==` method
@@ -175,7 +154,7 @@ module PureCloud
175
154
  # Calculates hash code according to all attributes.
176
155
  # @return [Fixnum] Hash code
177
156
  def hash
178
- [i_millis, before_now, after_now, equal_now].hash
157
+ [uri, title, description].hash
179
158
  end
180
159
 
181
160
  # build the object from hash