purecloudplatformclientv2 47.0.0 → 48.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 (99) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/docs/AnalyticsApi.md +66 -0
  4. data/docs/AnalyticsSession.md +1 -1
  5. data/docs/AuthorizationApi.md +9 -5
  6. data/docs/Condition.md +4 -4
  7. data/docs/ContactColumnToDataActionFieldMapping.md +12 -0
  8. data/docs/ConversationProperties.md +21 -0
  9. data/docs/DataActionConditionPredicate.md +12 -0
  10. data/docs/GroupsApi.md +1 -1
  11. data/docs/OrgUser.md +1 -0
  12. data/docs/OutboundApi.md +2 -2
  13. data/docs/QualityApi.md +376 -0
  14. data/docs/RoutingApi.md +85 -12
  15. data/docs/ScorableSurvey.md +18 -0
  16. data/docs/SearchApi.md +2 -42
  17. data/docs/SuggestApi.md +2 -2
  18. data/docs/Survey.md +22 -0
  19. data/docs/SurveyFormAndScoringSet.md +14 -0
  20. data/docs/SurveyQuestionGroupScore.md +17 -0
  21. data/docs/SurveyQuestionScore.md +19 -0
  22. data/docs/SurveyScoringSet.md +15 -0
  23. data/docs/Token.md +13 -0
  24. data/docs/TrustUser.md +1 -0
  25. data/docs/User.md +1 -0
  26. data/docs/UserMe.md +1 -0
  27. data/docs/UsersApi.md +8 -8
  28. data/docs/UtilitiesApi.md +59 -0
  29. data/docs/ViewFilter.md +13 -0
  30. data/lib/purecloudplatformclientv2.rb +10 -0
  31. data/lib/purecloudplatformclientv2/api/alerting_api.rb +11 -11
  32. data/lib/purecloudplatformclientv2/api/analytics_api.rb +91 -26
  33. data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -81
  34. data/lib/purecloudplatformclientv2/api/attributes_api.rb +6 -6
  35. data/lib/purecloudplatformclientv2/api/authorization_api.rb +45 -36
  36. data/lib/purecloudplatformclientv2/api/billing_api.rb +2 -2
  37. data/lib/purecloudplatformclientv2/api/content_management_api.rb +38 -38
  38. data/lib/purecloudplatformclientv2/api/conversations_api.rb +100 -100
  39. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +30 -30
  40. data/lib/purecloudplatformclientv2/api/fax_api.rb +6 -6
  41. data/lib/purecloudplatformclientv2/api/flows_api.rb +1 -1
  42. data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +4 -4
  43. data/lib/purecloudplatformclientv2/api/geolocation_api.rb +4 -4
  44. data/lib/purecloudplatformclientv2/api/greetings_api.rb +16 -16
  45. data/lib/purecloudplatformclientv2/api/groups_api.rb +14 -14
  46. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +28 -28
  47. data/lib/purecloudplatformclientv2/api/integrations_api.rb +41 -41
  48. data/lib/purecloudplatformclientv2/api/languages_api.rb +10 -10
  49. data/lib/purecloudplatformclientv2/api/license_api.rb +8 -8
  50. data/lib/purecloudplatformclientv2/api/locations_api.rb +4 -4
  51. data/lib/purecloudplatformclientv2/api/messaging_api.rb +14 -14
  52. data/lib/purecloudplatformclientv2/api/mobile_devices_api.rb +5 -5
  53. data/lib/purecloudplatformclientv2/api/notifications_api.rb +7 -7
  54. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +6 -6
  55. data/lib/purecloudplatformclientv2/api/objects_api.rb +8 -8
  56. data/lib/purecloudplatformclientv2/api/organization_api.rb +4 -4
  57. data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +23 -23
  58. data/lib/purecloudplatformclientv2/api/outbound_api.rb +98 -98
  59. data/lib/purecloudplatformclientv2/api/presence_api.rb +9 -9
  60. data/lib/purecloudplatformclientv2/api/quality_api.rb +450 -52
  61. data/lib/purecloudplatformclientv2/api/recording_api.rb +37 -37
  62. data/lib/purecloudplatformclientv2/api/response_management_api.rb +11 -11
  63. data/lib/purecloudplatformclientv2/api/routing_api.rb +173 -70
  64. data/lib/purecloudplatformclientv2/api/scripts_api.rb +11 -11
  65. data/lib/purecloudplatformclientv2/api/search_api.rb +16 -16
  66. data/lib/purecloudplatformclientv2/api/stations_api.rb +5 -5
  67. data/lib/purecloudplatformclientv2/api/suggest_api.rb +4 -4
  68. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +125 -125
  69. data/lib/purecloudplatformclientv2/api/tokens_api.rb +2 -2
  70. data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +6 -6
  71. data/lib/purecloudplatformclientv2/api/users_api.rb +61 -61
  72. data/lib/purecloudplatformclientv2/api/utilities_api.rb +58 -3
  73. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +24 -24
  74. data/lib/purecloudplatformclientv2/api/web_chat_api.rb +8 -8
  75. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -64
  76. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  77. data/lib/purecloudplatformclientv2/configuration.rb +9 -2
  78. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  79. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  80. data/lib/purecloudplatformclientv2/models/analytics_session.rb +1 -1
  81. data/lib/purecloudplatformclientv2/models/condition.rb +6 -6
  82. data/lib/purecloudplatformclientv2/models/contact_column_to_data_action_field_mapping.rb +176 -0
  83. data/lib/purecloudplatformclientv2/models/conversation_properties.rb +410 -0
  84. data/lib/purecloudplatformclientv2/models/data_action_condition_predicate.rb +176 -0
  85. data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/org_user.rb +27 -1
  87. data/lib/purecloudplatformclientv2/models/scorable_survey.rb +343 -0
  88. data/lib/purecloudplatformclientv2/models/survey.rb +444 -0
  89. data/lib/purecloudplatformclientv2/models/survey_form_and_scoring_set.rb +226 -0
  90. data/lib/purecloudplatformclientv2/models/survey_question_group_score.rb +303 -0
  91. data/lib/purecloudplatformclientv2/models/survey_question_score.rb +351 -0
  92. data/lib/purecloudplatformclientv2/models/survey_scoring_set.rb +253 -0
  93. data/lib/purecloudplatformclientv2/models/token.rb +207 -0
  94. data/lib/purecloudplatformclientv2/models/trust_user.rb +27 -1
  95. data/lib/purecloudplatformclientv2/models/user.rb +27 -1
  96. data/lib/purecloudplatformclientv2/models/user_me.rb +27 -1
  97. data/lib/purecloudplatformclientv2/models/view_filter.rb +354 -4
  98. data/lib/purecloudplatformclientv2/version.rb +1 -1
  99. metadata +22 -2
@@ -0,0 +1,253 @@
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 SurveyScoringSet
21
+ attr_accessor :total_score
22
+
23
+ attr_accessor :nps_score
24
+
25
+ attr_accessor :question_group_scores
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+
31
+ :'total_score' => :'totalScore',
32
+
33
+ :'nps_score' => :'npsScore',
34
+
35
+ :'question_group_scores' => :'questionGroupScores'
36
+
37
+ }
38
+ end
39
+
40
+ # Attribute type mapping.
41
+ def self.swagger_types
42
+ {
43
+
44
+ :'total_score' => :'Float',
45
+
46
+ :'nps_score' => :'Integer',
47
+
48
+ :'question_group_scores' => :'Array<SurveyQuestionGroupScore>'
49
+
50
+ }
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ return unless attributes.is_a?(Hash)
57
+
58
+ # convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
60
+
61
+
62
+ if attributes.has_key?(:'totalScore')
63
+
64
+
65
+ self.total_score = attributes[:'totalScore']
66
+
67
+
68
+ end
69
+
70
+
71
+ if attributes.has_key?(:'npsScore')
72
+
73
+
74
+ self.nps_score = attributes[:'npsScore']
75
+
76
+
77
+ end
78
+
79
+
80
+ if attributes.has_key?(:'questionGroupScores')
81
+
82
+ if (value = attributes[:'questionGroupScores']).is_a?(Array)
83
+ self.question_group_scores = value
84
+ end
85
+
86
+
87
+
88
+ end
89
+
90
+
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properies with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+
98
+
99
+ return invalid_properties
100
+ end
101
+
102
+ # Check to see if the all the properties in the model are valid
103
+ # @return true if the model is valid
104
+ def valid?
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+ end
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ # Checks equality by comparing each attribute.
137
+ # @param [Object] Object to be compared
138
+ def ==(o)
139
+ return true if self.equal?(o)
140
+ self.class == o.class &&
141
+ total_score == o.total_score &&
142
+ nps_score == o.nps_score &&
143
+ question_group_scores == o.question_group_scores
144
+ end
145
+
146
+ # @see the `==` method
147
+ # @param [Object] Object to be compared
148
+ def eql?(o)
149
+ self == o
150
+ end
151
+
152
+ # Calculates hash code according to all attributes.
153
+ # @return [Fixnum] Hash code
154
+ def hash
155
+ [total_score, nps_score, question_group_scores].hash
156
+ end
157
+
158
+ # build the object from hash
159
+ def build_from_hash(attributes)
160
+ return nil unless attributes.is_a?(Hash)
161
+ self.class.swagger_types.each_pair do |key, type|
162
+ if type =~ /^Array<(.*)>/i
163
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
164
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
165
+ else
166
+ #TODO show warning in debug mode
167
+ end
168
+ elsif !attributes[self.class.attribute_map[key]].nil?
169
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
170
+ else
171
+ # data not found in attributes(hash), not an issue as the data can be optional
172
+ end
173
+ end
174
+
175
+ self
176
+ end
177
+
178
+ def _deserialize(type, value)
179
+ case type.to_sym
180
+ when :DateTime
181
+ DateTime.parse(value)
182
+ when :Date
183
+ Date.parse(value)
184
+ when :String
185
+ value.to_s
186
+ when :Integer
187
+ value.to_i
188
+ when :Float
189
+ value.to_f
190
+ when :BOOLEAN
191
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
192
+ true
193
+ else
194
+ false
195
+ end
196
+ when :Object
197
+ # generic object (usually a Hash), return directly
198
+ value
199
+ when /\AArray<(?<inner_type>.+)>\z/
200
+ inner_type = Regexp.last_match[:inner_type]
201
+ value.map { |v| _deserialize(inner_type, v) }
202
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
203
+ k_type = Regexp.last_match[:k_type]
204
+ v_type = Regexp.last_match[:v_type]
205
+ {}.tap do |hash|
206
+ value.each do |k, v|
207
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
208
+ end
209
+ end
210
+ else # model
211
+ _model = Object.const_get("PureCloud").const_get(type).new
212
+ _model.build_from_hash(value)
213
+ end
214
+ end
215
+
216
+ def to_s
217
+ to_hash.to_s
218
+ end
219
+
220
+ # to_body is an alias to to_body (backward compatibility))
221
+ def to_body
222
+ to_hash
223
+ end
224
+
225
+ # return the object in the form of hash
226
+ def to_hash
227
+ hash = {}
228
+ self.class.attribute_map.each_pair do |attr, param|
229
+ value = self.send(attr)
230
+ next if value.nil?
231
+ hash[param] = _to_hash(value)
232
+ end
233
+ hash
234
+ end
235
+
236
+ # Method to output non-array value in the form of hash
237
+ # For object, use to_hash. Otherwise, just return the value
238
+ def _to_hash(value)
239
+ if value.is_a?(Array)
240
+ value.compact.map{ |v| _to_hash(v) }
241
+ elsif value.is_a?(Hash)
242
+ {}.tap do |hash|
243
+ value.each { |k, v| hash[k] = _to_hash(v) }
244
+ end
245
+ elsif value.respond_to? :to_hash
246
+ value.to_hash
247
+ else
248
+ value
249
+ end
250
+ end
251
+
252
+ end
253
+ end
@@ -0,0 +1,207 @@
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 Token
21
+ # Token for use with common api
22
+ attr_accessor :jwt
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+
28
+ :'jwt' => :'jwt'
29
+
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.swagger_types
35
+ {
36
+
37
+ :'jwt' => :'String'
38
+
39
+ }
40
+ end
41
+
42
+ # Initializes the object
43
+ # @param [Hash] attributes Model attributes in the form of hash
44
+ def initialize(attributes = {})
45
+ return unless attributes.is_a?(Hash)
46
+
47
+ # convert string to symbol for hash key
48
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
49
+
50
+
51
+ if attributes.has_key?(:'jwt')
52
+
53
+
54
+ self.jwt = attributes[:'jwt']
55
+
56
+
57
+ end
58
+
59
+
60
+ end
61
+
62
+ # Show invalid properties with the reasons. Usually used together with valid?
63
+ # @return Array for valid properies with the reasons
64
+ def list_invalid_properties
65
+ invalid_properties = Array.new
66
+
67
+
68
+ return invalid_properties
69
+ end
70
+
71
+ # Check to see if the all the properties in the model are valid
72
+ # @return true if the model is valid
73
+ def valid?
74
+
75
+
76
+ if @jwt.nil?
77
+ return false
78
+ end
79
+
80
+
81
+
82
+
83
+
84
+ end
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+ # Checks equality by comparing each attribute.
93
+ # @param [Object] Object to be compared
94
+ def ==(o)
95
+ return true if self.equal?(o)
96
+ self.class == o.class &&
97
+ jwt == o.jwt
98
+ end
99
+
100
+ # @see the `==` method
101
+ # @param [Object] Object to be compared
102
+ def eql?(o)
103
+ self == o
104
+ end
105
+
106
+ # Calculates hash code according to all attributes.
107
+ # @return [Fixnum] Hash code
108
+ def hash
109
+ [jwt].hash
110
+ end
111
+
112
+ # build the object from hash
113
+ def build_from_hash(attributes)
114
+ return nil unless attributes.is_a?(Hash)
115
+ self.class.swagger_types.each_pair do |key, type|
116
+ if type =~ /^Array<(.*)>/i
117
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
118
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
119
+ else
120
+ #TODO show warning in debug mode
121
+ end
122
+ elsif !attributes[self.class.attribute_map[key]].nil?
123
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
124
+ else
125
+ # data not found in attributes(hash), not an issue as the data can be optional
126
+ end
127
+ end
128
+
129
+ self
130
+ end
131
+
132
+ def _deserialize(type, value)
133
+ case type.to_sym
134
+ when :DateTime
135
+ DateTime.parse(value)
136
+ when :Date
137
+ Date.parse(value)
138
+ when :String
139
+ value.to_s
140
+ when :Integer
141
+ value.to_i
142
+ when :Float
143
+ value.to_f
144
+ when :BOOLEAN
145
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
146
+ true
147
+ else
148
+ false
149
+ end
150
+ when :Object
151
+ # generic object (usually a Hash), return directly
152
+ value
153
+ when /\AArray<(?<inner_type>.+)>\z/
154
+ inner_type = Regexp.last_match[:inner_type]
155
+ value.map { |v| _deserialize(inner_type, v) }
156
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
157
+ k_type = Regexp.last_match[:k_type]
158
+ v_type = Regexp.last_match[:v_type]
159
+ {}.tap do |hash|
160
+ value.each do |k, v|
161
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
162
+ end
163
+ end
164
+ else # model
165
+ _model = Object.const_get("PureCloud").const_get(type).new
166
+ _model.build_from_hash(value)
167
+ end
168
+ end
169
+
170
+ def to_s
171
+ to_hash.to_s
172
+ end
173
+
174
+ # to_body is an alias to to_body (backward compatibility))
175
+ def to_body
176
+ to_hash
177
+ end
178
+
179
+ # return the object in the form of hash
180
+ def to_hash
181
+ hash = {}
182
+ self.class.attribute_map.each_pair do |attr, param|
183
+ value = self.send(attr)
184
+ next if value.nil?
185
+ hash[param] = _to_hash(value)
186
+ end
187
+ hash
188
+ end
189
+
190
+ # Method to output non-array value in the form of hash
191
+ # For object, use to_hash. Otherwise, just return the value
192
+ def _to_hash(value)
193
+ if value.is_a?(Array)
194
+ value.compact.map{ |v| _to_hash(v) }
195
+ elsif value.is_a?(Hash)
196
+ {}.tap do |hash|
197
+ value.each { |k, v| hash[k] = _to_hash(v) }
198
+ end
199
+ elsif value.respond_to? :to_hash
200
+ value.to_hash
201
+ else
202
+ value
203
+ end
204
+ end
205
+
206
+ end
207
+ end