purecloudplatformclientv2 48.2.0 → 49.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 (42) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsFlow.md +2 -0
  4. data/docs/AnalyticsSession.md +7 -0
  5. data/docs/AuthorizationApi.md +1 -2
  6. data/docs/ExternalContact.md +1 -0
  7. data/docs/LocationDefinition.md +1 -1
  8. data/docs/LocationUpdateDefinition.md +19 -0
  9. data/docs/LocationsApi.md +202 -0
  10. data/docs/OAuthClient.md +1 -0
  11. data/docs/OAuthClientListing.md +1 -0
  12. data/docs/ObjectsApi.md +1 -2
  13. data/docs/OrgOAuthClient.md +1 -0
  14. data/docs/RoleDivision.md +14 -0
  15. data/docs/ViewFilter.md +9 -0
  16. data/docs/WebChatDeployment.md +1 -0
  17. data/docs/WhatsAppId.md +14 -0
  18. data/lib/purecloudplatformclientv2.rb +3 -3
  19. data/lib/purecloudplatformclientv2/api/locations_api.rb +213 -0
  20. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  21. data/lib/purecloudplatformclientv2/models/analytics_flow.rb +67 -1
  22. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  23. data/lib/purecloudplatformclientv2/models/analytics_session.rb +186 -4
  24. data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
  25. data/lib/purecloudplatformclientv2/models/location_definition.rb +6 -0
  26. data/lib/purecloudplatformclientv2/models/{attribute_entity_listing.rb → location_update_definition.rb} +62 -121
  27. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +29 -1
  28. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +29 -1
  29. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +29 -1
  30. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
  31. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  32. data/lib/purecloudplatformclientv2/models/{attribute_query_request.rb → role_division.rb} +24 -41
  33. data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +2 -2
  34. data/lib/purecloudplatformclientv2/models/view_filter.rb +256 -4
  35. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +28 -1
  36. data/lib/purecloudplatformclientv2/models/whats_app_id.rb +229 -0
  37. data/lib/purecloudplatformclientv2/version.rb +1 -1
  38. metadata +8 -8
  39. data/docs/AttributeEntityListing.md +0 -22
  40. data/docs/AttributeQueryRequest.md +0 -15
  41. data/docs/AttributesApi.md +0 -407
  42. data/lib/purecloudplatformclientv2/api/attributes_api.rb +0 -434
@@ -53,6 +53,8 @@ module PureCloud
53
53
 
54
54
  attr_accessor :line_id
55
55
 
56
+ attr_accessor :whats_app_id
57
+
56
58
  attr_accessor :facebook_id
57
59
 
58
60
  # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
@@ -110,6 +112,8 @@ module PureCloud
110
112
 
111
113
  :'line_id' => :'lineId',
112
114
 
115
+ :'whats_app_id' => :'whatsAppId',
116
+
113
117
  :'facebook_id' => :'facebookId',
114
118
 
115
119
  :'modify_date' => :'modifyDate',
@@ -165,6 +169,8 @@ module PureCloud
165
169
 
166
170
  :'line_id' => :'LineId',
167
171
 
172
+ :'whats_app_id' => :'WhatsAppId',
173
+
168
174
  :'facebook_id' => :'FacebookId',
169
175
 
170
176
  :'modify_date' => :'DateTime',
@@ -337,6 +343,15 @@ module PureCloud
337
343
  end
338
344
 
339
345
 
346
+ if attributes.has_key?(:'whatsAppId')
347
+
348
+
349
+ self.whats_app_id = attributes[:'whatsAppId']
350
+
351
+
352
+ end
353
+
354
+
340
355
  if attributes.has_key?(:'facebookId')
341
356
 
342
357
 
@@ -527,6 +542,10 @@ module PureCloud
527
542
 
528
543
 
529
544
 
545
+
546
+
547
+
548
+
530
549
 
531
550
 
532
551
 
@@ -649,6 +668,11 @@ module PureCloud
649
668
 
650
669
 
651
670
 
671
+
672
+
673
+
674
+
675
+
652
676
 
653
677
 
654
678
 
@@ -676,6 +700,7 @@ module PureCloud
676
700
  address == o.address &&
677
701
  twitter_id == o.twitter_id &&
678
702
  line_id == o.line_id &&
703
+ whats_app_id == o.whats_app_id &&
679
704
  facebook_id == o.facebook_id &&
680
705
  modify_date == o.modify_date &&
681
706
  create_date == o.create_date &&
@@ -695,7 +720,7 @@ module PureCloud
695
720
  # Calculates hash code according to all attributes.
696
721
  # @return [Fixnum] Hash code
697
722
  def hash
698
- [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, twitter_id, line_id, facebook_id, modify_date, create_date, external_organization, survey_opt_out, external_system_url, external_data_sources, self_uri].hash
723
+ [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, twitter_id, line_id, whats_app_id, facebook_id, modify_date, create_date, external_organization, survey_opt_out, external_system_url, external_data_sources, self_uri].hash
699
724
  end
700
725
 
701
726
  # build the object from hash
@@ -21,6 +21,7 @@ module PureCloud
21
21
  # The globally unique identifier for the object.
22
22
  attr_accessor :id
23
23
 
24
+ # The name of the Location.
24
25
  attr_accessor :name
25
26
 
26
27
  attr_accessor :address
@@ -201,6 +202,11 @@ module PureCloud
201
202
 
202
203
 
203
204
 
205
+ if @name.nil?
206
+ return false
207
+ end
208
+
209
+
204
210
 
205
211
 
206
212
 
@@ -17,50 +17,40 @@ Terms of Service: https://developer.mypurecloud.com/tos
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- class AttributeEntityListing
21
- attr_accessor :entities
20
+ class LocationUpdateDefinition
21
+ # The name of the Location.
22
+ attr_accessor :name
22
23
 
23
- attr_accessor :page_size
24
+ attr_accessor :address
24
25
 
25
- attr_accessor :page_number
26
+ attr_accessor :address_verified
26
27
 
27
- attr_accessor :total
28
+ attr_accessor :emergency_number
28
29
 
29
- attr_accessor :first_uri
30
+ # Current activity status of the location.
31
+ attr_accessor :state
30
32
 
31
- attr_accessor :self_uri
33
+ attr_accessor :version
32
34
 
33
- attr_accessor :previous_uri
34
-
35
- attr_accessor :next_uri
36
-
37
- attr_accessor :last_uri
38
-
39
- attr_accessor :page_count
35
+ attr_accessor :path
40
36
 
41
37
  # Attribute mapping from ruby-style variable name to JSON key.
42
38
  def self.attribute_map
43
39
  {
44
40
 
45
- :'entities' => :'entities',
46
-
47
- :'page_size' => :'pageSize',
41
+ :'name' => :'name',
48
42
 
49
- :'page_number' => :'pageNumber',
43
+ :'address' => :'address',
50
44
 
51
- :'total' => :'total',
45
+ :'address_verified' => :'addressVerified',
52
46
 
53
- :'first_uri' => :'firstUri',
47
+ :'emergency_number' => :'emergencyNumber',
54
48
 
55
- :'self_uri' => :'selfUri',
49
+ :'state' => :'state',
56
50
 
57
- :'previous_uri' => :'previousUri',
51
+ :'version' => :'version',
58
52
 
59
- :'next_uri' => :'nextUri',
60
-
61
- :'last_uri' => :'lastUri',
62
-
63
- :'page_count' => :'pageCount'
53
+ :'path' => :'path'
64
54
 
65
55
  }
66
56
  end
@@ -69,25 +59,19 @@ module PureCloud
69
59
  def self.swagger_types
70
60
  {
71
61
 
72
- :'entities' => :'Array<Attribute>',
73
-
74
- :'page_size' => :'Integer',
75
-
76
- :'page_number' => :'Integer',
62
+ :'name' => :'String',
77
63
 
78
- :'total' => :'Integer',
64
+ :'address' => :'LocationAddress',
79
65
 
80
- :'first_uri' => :'String',
66
+ :'address_verified' => :'BOOLEAN',
81
67
 
82
- :'self_uri' => :'String',
68
+ :'emergency_number' => :'LocationEmergencyNumber',
83
69
 
84
- :'previous_uri' => :'String',
70
+ :'state' => :'String',
85
71
 
86
- :'next_uri' => :'String',
72
+ :'version' => :'Integer',
87
73
 
88
- :'last_uri' => :'String',
89
-
90
- :'page_count' => :'Integer'
74
+ :'path' => :'Array<String>'
91
75
 
92
76
  }
93
77
  end
@@ -101,93 +85,66 @@ module PureCloud
101
85
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
102
86
 
103
87
 
104
- if attributes.has_key?(:'entities')
105
-
106
- if (value = attributes[:'entities']).is_a?(Array)
107
- self.entities = value
108
- end
109
-
110
-
111
-
112
- end
113
-
114
-
115
- if attributes.has_key?(:'pageSize')
116
-
117
-
118
- self.page_size = attributes[:'pageSize']
119
-
120
-
121
- end
122
-
123
-
124
- if attributes.has_key?(:'pageNumber')
88
+ if attributes.has_key?(:'name')
125
89
 
126
90
 
127
- self.page_number = attributes[:'pageNumber']
91
+ self.name = attributes[:'name']
128
92
 
129
93
 
130
94
  end
131
95
 
132
96
 
133
- if attributes.has_key?(:'total')
97
+ if attributes.has_key?(:'address')
134
98
 
135
99
 
136
- self.total = attributes[:'total']
100
+ self.address = attributes[:'address']
137
101
 
138
102
 
139
103
  end
140
104
 
141
105
 
142
- if attributes.has_key?(:'firstUri')
106
+ if attributes.has_key?(:'addressVerified')
143
107
 
144
108
 
145
- self.first_uri = attributes[:'firstUri']
109
+ self.address_verified = attributes[:'addressVerified']
146
110
 
147
111
 
148
112
  end
149
113
 
150
114
 
151
- if attributes.has_key?(:'selfUri')
115
+ if attributes.has_key?(:'emergencyNumber')
152
116
 
153
117
 
154
- self.self_uri = attributes[:'selfUri']
118
+ self.emergency_number = attributes[:'emergencyNumber']
155
119
 
156
120
 
157
121
  end
158
122
 
159
123
 
160
- if attributes.has_key?(:'previousUri')
124
+ if attributes.has_key?(:'state')
161
125
 
162
126
 
163
- self.previous_uri = attributes[:'previousUri']
127
+ self.state = attributes[:'state']
164
128
 
165
129
 
166
130
  end
167
131
 
168
132
 
169
- if attributes.has_key?(:'nextUri')
133
+ if attributes.has_key?(:'version')
170
134
 
171
135
 
172
- self.next_uri = attributes[:'nextUri']
136
+ self.version = attributes[:'version']
173
137
 
174
138
 
175
139
  end
176
140
 
177
141
 
178
- if attributes.has_key?(:'lastUri')
179
-
180
-
181
- self.last_uri = attributes[:'lastUri']
182
-
183
-
184
- end
185
-
186
-
187
- if attributes.has_key?(:'pageCount')
142
+ if attributes.has_key?(:'path')
188
143
 
144
+ if (value = attributes[:'path']).is_a?(Array)
145
+ self.path = value
146
+ end
189
147
 
190
- self.page_count = attributes[:'pageCount']
191
148
 
192
149
 
193
150
  end
@@ -226,17 +183,10 @@ module PureCloud
226
183
 
227
184
 
228
185
 
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
186
+ allowed_values = ["active", "deleted"]
187
+ if @state && !allowed_values.include?(@state)
188
+ return false
189
+ end
240
190
 
241
191
 
242
192
 
@@ -272,22 +222,16 @@ module PureCloud
272
222
 
273
223
 
274
224
 
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
225
+ # Custom attribute writer method checking allowed values (enum).
226
+ # @param [Object] state Object to be assigned
227
+ def state=(state)
228
+ allowed_values = ["active", "deleted"]
229
+ if state && !allowed_values.include?(state)
230
+ fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
231
+ end
232
+ @state = state
233
+ end
234
+
291
235
 
292
236
 
293
237
 
@@ -306,16 +250,13 @@ module PureCloud
306
250
  def ==(o)
307
251
  return true if self.equal?(o)
308
252
  self.class == o.class &&
309
- entities == o.entities &&
310
- page_size == o.page_size &&
311
- page_number == o.page_number &&
312
- total == o.total &&
313
- first_uri == o.first_uri &&
314
- self_uri == o.self_uri &&
315
- previous_uri == o.previous_uri &&
316
- next_uri == o.next_uri &&
317
- last_uri == o.last_uri &&
318
- page_count == o.page_count
253
+ name == o.name &&
254
+ address == o.address &&
255
+ address_verified == o.address_verified &&
256
+ emergency_number == o.emergency_number &&
257
+ state == o.state &&
258
+ version == o.version &&
259
+ path == o.path
319
260
  end
320
261
 
321
262
  # @see the `==` method
@@ -327,7 +268,7 @@ module PureCloud
327
268
  # Calculates hash code according to all attributes.
328
269
  # @return [Fixnum] Hash code
329
270
  def hash
330
- [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, next_uri, last_uri, page_count].hash
271
+ [name, address, address_verified, emergency_number, state, version, path].hash
331
272
  end
332
273
 
333
274
  # build the object from hash
@@ -56,6 +56,9 @@ module PureCloud
56
56
  # The scope requested by this client
57
57
  attr_accessor :scope
58
58
 
59
+ # Set of roles and their corresponding divisions associated with this client
60
+ attr_accessor :role_divisions
61
+
59
62
  # The URI for this object
60
63
  attr_accessor :self_uri
61
64
 
@@ -89,6 +92,8 @@ module PureCloud
89
92
 
90
93
  :'scope' => :'scope',
91
94
 
95
+ :'role_divisions' => :'roleDivisions',
96
+
92
97
  :'self_uri' => :'selfUri'
93
98
 
94
99
  }
@@ -124,6 +129,8 @@ module PureCloud
124
129
 
125
130
  :'scope' => :'Array<String>',
126
131
 
132
+ :'role_divisions' => :'Array<RoleDivision>',
133
+
127
134
  :'self_uri' => :'String'
128
135
 
129
136
  }
@@ -258,6 +265,17 @@ module PureCloud
258
265
 
259
266
 
260
267
 
268
+ end
269
+
270
+
271
+ if attributes.has_key?(:'roleDivisions')
272
+
273
+ if (value = attributes[:'roleDivisions']).is_a?(Array)
274
+ self.role_divisions = value
275
+ end
276
+
277
+
278
+
261
279
  end
262
280
 
263
281
 
@@ -361,6 +379,10 @@ module PureCloud
361
379
 
362
380
 
363
381
 
382
+
383
+
384
+
385
+
364
386
  end
365
387
 
366
388
 
@@ -443,6 +465,11 @@ module PureCloud
443
465
 
444
466
 
445
467
 
468
+
469
+
470
+
471
+
472
+
446
473
  # Checks equality by comparing each attribute.
447
474
  # @param [Object] Object to be compared
448
475
  def ==(o)
@@ -461,6 +488,7 @@ module PureCloud
461
488
  modified_by == o.modified_by &&
462
489
  authorized_grant_type == o.authorized_grant_type &&
463
490
  scope == o.scope &&
491
+ role_divisions == o.role_divisions &&
464
492
  self_uri == o.self_uri
465
493
  end
466
494
 
@@ -473,7 +501,7 @@ module PureCloud
473
501
  # Calculates hash code according to all attributes.
474
502
  # @return [Fixnum] Hash code
475
503
  def hash
476
- [id, name, access_token_validity_seconds, description, registered_redirect_uri, secret, role_ids, date_created, date_modified, created_by, modified_by, authorized_grant_type, scope, self_uri].hash
504
+ [id, name, access_token_validity_seconds, description, registered_redirect_uri, secret, role_ids, date_created, date_modified, created_by, modified_by, authorized_grant_type, scope, role_divisions, self_uri].hash
477
505
  end
478
506
 
479
507
  # build the object from hash