purecloudplatformclientv2 86.0.0 → 87.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 (125) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/CoachingAnnotation.md +21 -0
  5. data/docs/CoachingAnnotationCreateRequest.md +14 -0
  6. data/docs/CoachingAnnotationList.md +22 -0
  7. data/docs/CoachingApi.md +1132 -0
  8. data/docs/CoachingAppointmentReference.md +14 -0
  9. data/docs/CoachingAppointmentResponse.md +27 -0
  10. data/docs/CoachingAppointmentResponseList.md +22 -0
  11. data/docs/CoachingAppointmentStatusDto.md +16 -0
  12. data/docs/CoachingAppointmentStatusDtoList.md +17 -0
  13. data/docs/CoachingNotification.md +23 -0
  14. data/docs/CoachingNotificationList.md +22 -0
  15. data/docs/ConversationEventTopicCall.md +1 -0
  16. data/docs/ConversationEventTopicCallback.md +1 -0
  17. data/docs/ConversationEventTopicChat.md +1 -0
  18. data/docs/ConversationEventTopicCobrowse.md +1 -0
  19. data/docs/ConversationEventTopicEmail.md +1 -0
  20. data/docs/ConversationEventTopicMessage.md +1 -0
  21. data/docs/ConversationEventTopicScreenshare.md +1 -0
  22. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  23. data/docs/ConversationEventTopicVideo.md +1 -0
  24. data/docs/ConversationReference.md +14 -0
  25. data/docs/CreateCoachingAppointmentRequest.md +20 -0
  26. data/docs/DocumentReference.md +14 -0
  27. data/docs/EntityListing.md +5 -1
  28. data/docs/QueueConversationEventTopicCall.md +1 -0
  29. data/docs/QueueConversationEventTopicCallback.md +1 -0
  30. data/docs/QueueConversationEventTopicChat.md +1 -0
  31. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  32. data/docs/QueueConversationEventTopicEmail.md +1 -0
  33. data/docs/QueueConversationEventTopicMessage.md +1 -0
  34. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  35. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  36. data/docs/QueueConversationEventTopicVideo.md +1 -0
  37. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  38. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  39. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  40. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  41. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  42. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
  43. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  44. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  45. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  46. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  47. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  48. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  49. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  50. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  51. data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
  52. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  53. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  54. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  55. data/docs/UpdateCoachingAppointmentRequest.md +18 -0
  56. data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
  57. data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
  58. data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
  59. data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
  60. data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
  61. data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
  62. data/lib/purecloudplatformclientv2.rb +21 -0
  63. data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
  64. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  65. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  66. data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
  67. data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
  68. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
  69. data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
  70. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
  71. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
  72. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
  73. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
  74. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
  75. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
  76. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
  77. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  78. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  79. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  80. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  81. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  82. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
  83. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  84. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  85. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  86. data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
  87. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
  88. data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
  89. data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
  90. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  91. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  92. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  93. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  94. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  95. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
  96. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  97. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  98. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  99. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  100. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  101. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  102. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  103. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  104. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
  105. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  106. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  107. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  108. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  109. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  110. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  111. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  112. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  113. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
  114. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  115. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  116. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  117. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
  118. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
  119. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
  120. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
  121. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
  122. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
  123. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
  124. data/lib/purecloudplatformclientv2/version.rb +1 -1
  125. metadata +44 -2
@@ -0,0 +1,228 @@
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: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class DocumentReference
21
+ # The globally unique identifier for the object.
22
+ attr_accessor :id
23
+
24
+ # The URI for this object
25
+ attr_accessor :self_uri
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+
31
+ :'id' => :'id',
32
+
33
+ :'self_uri' => :'selfUri'
34
+
35
+ }
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.swagger_types
40
+ {
41
+
42
+ :'id' => :'String',
43
+
44
+ :'self_uri' => :'String'
45
+
46
+ }
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ return unless attributes.is_a?(Hash)
53
+
54
+ # convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
56
+
57
+
58
+ if attributes.has_key?(:'id')
59
+
60
+
61
+ self.id = attributes[:'id']
62
+
63
+
64
+ end
65
+
66
+
67
+ if attributes.has_key?(:'selfUri')
68
+
69
+
70
+ self.self_uri = attributes[:'selfUri']
71
+
72
+
73
+ end
74
+
75
+
76
+ end
77
+
78
+ # Show invalid properties with the reasons. Usually used together with valid?
79
+ # @return Array for valid properies with the reasons
80
+ def list_invalid_properties
81
+ invalid_properties = Array.new
82
+
83
+
84
+ return invalid_properties
85
+ end
86
+
87
+ # Check to see if the all the properties in the model are valid
88
+ # @return true if the model is valid
89
+ def valid?
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ end
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ # Checks equality by comparing each attribute.
113
+ # @param [Object] Object to be compared
114
+ def ==(o)
115
+ return true if self.equal?(o)
116
+ self.class == o.class &&
117
+ id == o.id &&
118
+ self_uri == o.self_uri
119
+ end
120
+
121
+ # @see the `==` method
122
+ # @param [Object] Object to be compared
123
+ def eql?(o)
124
+ self == o
125
+ end
126
+
127
+ # Calculates hash code according to all attributes.
128
+ # @return [Fixnum] Hash code
129
+ def hash
130
+ [id, self_uri].hash
131
+ end
132
+
133
+ # build the object from hash
134
+ def build_from_hash(attributes)
135
+ return nil unless attributes.is_a?(Hash)
136
+ self.class.swagger_types.each_pair do |key, type|
137
+ if type =~ /^Array<(.*)>/i
138
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
139
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
140
+ else
141
+ #TODO show warning in debug mode
142
+ end
143
+ elsif !attributes[self.class.attribute_map[key]].nil?
144
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
145
+ else
146
+ # data not found in attributes(hash), not an issue as the data can be optional
147
+ end
148
+ end
149
+
150
+ self
151
+ end
152
+
153
+ def _deserialize(type, value)
154
+ case type.to_sym
155
+ when :DateTime
156
+ DateTime.parse(value)
157
+ when :Date
158
+ Date.parse(value)
159
+ when :String
160
+ value.to_s
161
+ when :Integer
162
+ value.to_i
163
+ when :Float
164
+ value.to_f
165
+ when :BOOLEAN
166
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
167
+ true
168
+ else
169
+ false
170
+ end
171
+ when :Object
172
+ # generic object (usually a Hash), return directly
173
+ value
174
+ when /\AArray<(?<inner_type>.+)>\z/
175
+ inner_type = Regexp.last_match[:inner_type]
176
+ value.map { |v| _deserialize(inner_type, v) }
177
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
178
+ k_type = Regexp.last_match[:k_type]
179
+ v_type = Regexp.last_match[:v_type]
180
+ {}.tap do |hash|
181
+ value.each do |k, v|
182
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
183
+ end
184
+ end
185
+ else # model
186
+ _model = Object.const_get("PureCloud").const_get(type).new
187
+ _model.build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ def to_s
192
+ to_hash.to_s
193
+ end
194
+
195
+ # to_body is an alias to to_body (backward compatibility))
196
+ def to_body
197
+ to_hash
198
+ end
199
+
200
+ # return the object in the form of hash
201
+ def to_hash
202
+ hash = {}
203
+ self.class.attribute_map.each_pair do |attr, param|
204
+ value = self.send(attr)
205
+ next if value.nil?
206
+ hash[param] = _to_hash(value)
207
+ end
208
+ hash
209
+ end
210
+
211
+ # Method to output non-array value in the form of hash
212
+ # For object, use to_hash. Otherwise, just return the value
213
+ def _to_hash(value)
214
+ if value.is_a?(Array)
215
+ value.compact.map{ |v| _to_hash(v) }
216
+ elsif value.is_a?(Hash)
217
+ {}.tap do |hash|
218
+ value.each { |k, v| hash[k] = _to_hash(v) }
219
+ end
220
+ elsif value.respond_to? :to_hash
221
+ value.to_hash
222
+ else
223
+ value
224
+ end
225
+ end
226
+
227
+ end
228
+ end
@@ -20,11 +20,27 @@ module PureCloud
20
20
  class EntityListing
21
21
  attr_accessor :entities
22
22
 
23
+ attr_accessor :page_size
24
+
25
+ attr_accessor :page_number
26
+
27
+ attr_accessor :total
28
+
29
+ attr_accessor :page_count
30
+
23
31
  # Attribute mapping from ruby-style variable name to JSON key.
24
32
  def self.attribute_map
25
33
  {
26
34
 
27
- :'entities' => :'entities'
35
+ :'entities' => :'entities',
36
+
37
+ :'page_size' => :'pageSize',
38
+
39
+ :'page_number' => :'pageNumber',
40
+
41
+ :'total' => :'total',
42
+
43
+ :'page_count' => :'pageCount'
28
44
 
29
45
  }
30
46
  end
@@ -33,7 +49,15 @@ module PureCloud
33
49
  def self.swagger_types
34
50
  {
35
51
 
36
- :'entities' => :'Array<Object>'
52
+ :'entities' => :'Array<DataTableImportJob>',
53
+
54
+ :'page_size' => :'Integer',
55
+
56
+ :'page_number' => :'Integer',
57
+
58
+ :'total' => :'Integer',
59
+
60
+ :'page_count' => :'Integer'
37
61
 
38
62
  }
39
63
  end
@@ -58,6 +82,42 @@ module PureCloud
58
82
  end
59
83
 
60
84
 
85
+ if attributes.has_key?(:'pageSize')
86
+
87
+
88
+ self.page_size = attributes[:'pageSize']
89
+
90
+
91
+ end
92
+
93
+
94
+ if attributes.has_key?(:'pageNumber')
95
+
96
+
97
+ self.page_number = attributes[:'pageNumber']
98
+
99
+
100
+ end
101
+
102
+
103
+ if attributes.has_key?(:'total')
104
+
105
+
106
+ self.total = attributes[:'total']
107
+
108
+
109
+ end
110
+
111
+
112
+ if attributes.has_key?(:'pageCount')
113
+
114
+
115
+ self.page_count = attributes[:'pageCount']
116
+
117
+
118
+ end
119
+
120
+
61
121
  end
62
122
 
63
123
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,6 +132,22 @@ module PureCloud
72
132
  # Check to see if the all the properties in the model are valid
73
133
  # @return true if the model is valid
74
134
  def valid?
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
75
151
 
76
152
 
77
153
 
@@ -84,13 +160,37 @@ module PureCloud
84
160
 
85
161
 
86
162
 
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
87
183
 
88
184
  # Checks equality by comparing each attribute.
89
185
  # @param [Object] Object to be compared
90
186
  def ==(o)
91
187
  return true if self.equal?(o)
92
188
  self.class == o.class &&
93
- entities == o.entities
189
+ entities == o.entities &&
190
+ page_size == o.page_size &&
191
+ page_number == o.page_number &&
192
+ total == o.total &&
193
+ page_count == o.page_count
94
194
  end
95
195
 
96
196
  # @see the `==` method
@@ -102,7 +202,7 @@ module PureCloud
102
202
  # Calculates hash code according to all attributes.
103
203
  # @return [Fixnum] Hash code
104
204
  def hash
105
- [entities].hash
205
+ [entities, page_size, page_number, total, page_count].hash
106
206
  end
107
207
 
108
208
  # build the object from hash
@@ -62,6 +62,8 @@ module PureCloud
62
62
 
63
63
  attr_accessor :uui_data
64
64
 
65
+ attr_accessor :wrapup
66
+
65
67
  attr_accessor :additional_properties
66
68
 
67
69
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -112,6 +114,8 @@ module PureCloud
112
114
 
113
115
  :'uui_data' => :'uuiData',
114
116
 
117
+ :'wrapup' => :'wrapup',
118
+
115
119
  :'additional_properties' => :'additionalProperties'
116
120
 
117
121
  }
@@ -165,6 +169,8 @@ module PureCloud
165
169
 
166
170
  :'uui_data' => :'String',
167
171
 
172
+ :'wrapup' => :'QueueConversationEventTopicWrapup',
173
+
168
174
  :'additional_properties' => :'Object'
169
175
 
170
176
  }
@@ -379,6 +385,15 @@ module PureCloud
379
385
  end
380
386
 
381
387
 
388
+ if attributes.has_key?(:'wrapup')
389
+
390
+
391
+ self.wrapup = attributes[:'wrapup']
392
+
393
+
394
+ end
395
+
396
+
382
397
  if attributes.has_key?(:'additionalProperties')
383
398
 
384
399
 
@@ -510,6 +525,10 @@ module PureCloud
510
525
 
511
526
 
512
527
 
528
+
529
+
530
+
531
+
513
532
 
514
533
 
515
534
 
@@ -663,6 +682,11 @@ module PureCloud
663
682
 
664
683
 
665
684
 
685
+
686
+
687
+
688
+
689
+
666
690
 
667
691
 
668
692
 
@@ -696,6 +720,7 @@ module PureCloud
696
720
  disconnect_reasons == o.disconnect_reasons &&
697
721
  fax_status == o.fax_status &&
698
722
  uui_data == o.uui_data &&
723
+ wrapup == o.wrapup &&
699
724
  additional_properties == o.additional_properties
700
725
  end
701
726
 
@@ -708,7 +733,7 @@ module PureCloud
708
733
  # Calculates hash code according to all attributes.
709
734
  # @return [Fixnum] Hash code
710
735
  def hash
711
- [id, state, recording, recording_state, muted, confined, held, error_info, disconnect_type, start_hold_time, direction, document_id, _self, other, provider, script_id, peer_id, connected_time, disconnected_time, disconnect_reasons, fax_status, uui_data, additional_properties].hash
736
+ [id, state, recording, recording_state, muted, confined, held, error_info, disconnect_type, start_hold_time, direction, document_id, _self, other, provider, script_id, peer_id, connected_time, disconnected_time, disconnect_reasons, fax_status, uui_data, wrapup, additional_properties].hash
712
737
  end
713
738
 
714
739
  # build the object from hash