purecloudplatformclientv2 35.0.0 → 36.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdditionalMessage.md +2 -0
  4. data/docs/AlertingApi.md +0 -2
  5. data/docs/AnalyticsApi.md +0 -13
  6. data/docs/ArchitectApi.md +210 -150
  7. data/docs/AttributesApi.md +0 -6
  8. data/docs/AuthorizationApi.md +15 -7
  9. data/docs/BillingApi.md +4 -1
  10. data/docs/CampaignDivisionView.md +1 -1
  11. data/docs/ContentManagementApi.md +0 -38
  12. data/docs/ConversationsApi.md +141 -75
  13. data/docs/CreateQueueRequest.md +1 -1
  14. data/docs/Division.md +15 -0
  15. data/docs/FaxApi.md +0 -6
  16. data/docs/Flow.md +1 -1
  17. data/docs/FlowDivisionView.md +1 -0
  18. data/docs/FreeSeatingConfiguration.md +1 -1
  19. data/docs/GeolocationApi.md +0 -3
  20. data/docs/GreetingsApi.md +0 -16
  21. data/docs/GroupsApi.md +2 -12
  22. data/docs/IdentityProviderApi.md +18 -9
  23. data/docs/IntegrationsApi.md +26 -31
  24. data/docs/LanguagesApi.md +0 -4
  25. data/docs/LicenseApi.md +21 -8
  26. data/docs/LocationsApi.md +0 -3
  27. data/docs/ManagementUnit.md +1 -0
  28. data/docs/MessageData.md +1 -0
  29. data/docs/MessageDetails.md +1 -0
  30. data/docs/MessageMedia.md +3 -0
  31. data/docs/MessageMediaData.md +20 -0
  32. data/docs/MessageSticker.md +14 -0
  33. data/docs/MobileDevicesApi.md +0 -5
  34. data/docs/NotificationsApi.md +0 -7
  35. data/docs/OrganizationApi.md +0 -2
  36. data/docs/OrganizationAuthorizationApi.md +16 -6
  37. data/docs/OutboundApi.md +8 -6
  38. data/docs/OutboundSettings.md +1 -0
  39. data/docs/PresenceApi.md +0 -5
  40. data/docs/QualityApi.md +0 -21
  41. data/docs/Queue.md +1 -1
  42. data/docs/RecordingApi.md +0 -17
  43. data/docs/ResponseManagementApi.md +0 -11
  44. data/docs/RoutingApi.md +93 -9
  45. data/docs/SearchApi.md +0 -14
  46. data/docs/StationsApi.md +0 -3
  47. data/docs/SuggestApi.md +0 -4
  48. data/docs/SurveyForm.md +3 -1
  49. data/docs/TelephonyProvidersEdgeApi.md +4 -16
  50. data/docs/TokensApi.md +0 -2
  51. data/docs/UserQueue.md +1 -1
  52. data/docs/UserRecordingsApi.md +0 -6
  53. data/docs/UsersApi.md +31 -42
  54. data/docs/UtilitiesApi.md +0 -3
  55. data/docs/VoicemailApi.md +8 -21
  56. data/docs/WorkforceManagementApi.md +25 -4
  57. data/lib/purecloudplatformclientv2.rb +3 -0
  58. data/lib/purecloudplatformclientv2/api/architect_api.rb +136 -102
  59. data/lib/purecloudplatformclientv2/api/conversations_api.rb +160 -0
  60. data/lib/purecloudplatformclientv2/api/routing_api.rb +122 -0
  61. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +22 -0
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/additional_message.rb +60 -4
  64. data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +1 -1
  65. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  66. data/lib/purecloudplatformclientv2/models/division.rb +253 -0
  67. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  68. data/lib/purecloudplatformclientv2/models/flow.rb +1 -1
  69. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +27 -1
  70. data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +23 -9
  71. data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +29 -1
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
  74. data/lib/purecloudplatformclientv2/models/message_media.rb +82 -4
  75. data/lib/purecloudplatformclientv2/models/message_media_data.rb +411 -0
  76. data/lib/purecloudplatformclientv2/models/message_sticker.rb +228 -0
  77. data/lib/purecloudplatformclientv2/models/outbound_settings.rb +27 -1
  78. data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
  79. data/lib/purecloudplatformclientv2/models/survey_form.rb +53 -1
  80. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
  81. data/lib/purecloudplatformclientv2/version.rb +1 -1
  82. metadata +8 -2
@@ -301,7 +301,6 @@ Requires NO permissions:
301
301
 
302
302
 
303
303
 
304
-
305
304
  ### Example
306
305
  ~~~ruby
307
306
  # load the gem
@@ -360,7 +359,6 @@ Requires NO permissions:
360
359
 
361
360
 
362
361
 
363
-
364
362
  ### Example
365
363
  ~~~ruby
366
364
  # load the gem
@@ -425,7 +423,6 @@ Requires NO permissions:
425
423
 
426
424
 
427
425
 
428
-
429
426
  ### Example
430
427
  ~~~ruby
431
428
  # load the gem
@@ -490,7 +487,6 @@ Requires NO permissions:
490
487
 
491
488
 
492
489
 
493
-
494
490
  ### Example
495
491
  ~~~ruby
496
492
  # load the gem
@@ -32,7 +32,9 @@ Wraps GET /api/v2/license/definitions/{licenseId}
32
32
 
33
33
  Requires ANY permissions:
34
34
 
35
- * admin* role_manager* authorization:grant:add
35
+ * admin
36
+ * role_manager
37
+ * authorization:grant:add
36
38
 
37
39
 
38
40
  ### Example
@@ -97,7 +99,9 @@ Wraps GET /api/v2/license/definitions
97
99
 
98
100
  Requires ANY permissions:
99
101
 
100
- * admin* role_manager* authorization:grant:add
102
+ * admin
103
+ * role_manager
104
+ * authorization:grant:add
101
105
 
102
106
 
103
107
  ### Example
@@ -156,7 +160,9 @@ Wraps GET /api/v2/license/organization
156
160
 
157
161
  Requires ANY permissions:
158
162
 
159
- * admin* role_manager* authorization:grant:add
163
+ * admin
164
+ * role_manager
165
+ * authorization:grant:add
160
166
 
161
167
 
162
168
  ### Example
@@ -215,7 +221,9 @@ Wraps GET /api/v2/license/toggles/{featureName}
215
221
 
216
222
  Requires ANY permissions:
217
223
 
218
- * admin* role_manager* authorization:grant:add
224
+ * admin
225
+ * role_manager
226
+ * authorization:grant:add
219
227
 
220
228
 
221
229
  ### Example
@@ -280,7 +288,9 @@ Wraps GET /api/v2/license/users/{userId}
280
288
 
281
289
  Requires ANY permissions:
282
290
 
283
- * admin* role_manager* authorization:grant:add
291
+ * admin
292
+ * role_manager
293
+ * authorization:grant:add
284
294
 
285
295
 
286
296
  ### Example
@@ -345,7 +355,9 @@ Wraps POST /api/v2/license/organization
345
355
 
346
356
  Requires ANY permissions:
347
357
 
348
- * admin* role_manager* authorization:grant:add
358
+ * admin
359
+ * role_manager
360
+ * authorization:grant:add
349
361
 
350
362
 
351
363
  ### Example
@@ -411,7 +423,9 @@ Wraps POST /api/v2/license/toggles/{featureName}
411
423
 
412
424
  Requires ANY permissions:
413
425
 
414
- * admin* role_manager* authorization:grant:add
426
+ * admin
427
+ * role_manager
428
+ * authorization:grant:add
415
429
 
416
430
 
417
431
  ### Example
@@ -478,7 +492,6 @@ Requires NO permissions:
478
492
 
479
493
 
480
494
 
481
-
482
495
  ### Example
483
496
  ~~~ruby
484
497
  # load the gem
@@ -95,7 +95,6 @@ Requires NO permissions:
95
95
 
96
96
 
97
97
 
98
-
99
98
  ### Example
100
99
  ~~~ruby
101
100
  # load the gem
@@ -165,7 +164,6 @@ Requires NO permissions:
165
164
 
166
165
 
167
166
 
168
-
169
167
  ### Example
170
168
  ~~~ruby
171
169
  # load the gem
@@ -234,7 +232,6 @@ Requires NO permissions:
234
232
 
235
233
 
236
234
 
237
-
238
235
  ### Example
239
236
  ~~~ruby
240
237
  # load the gem
@@ -9,6 +9,7 @@ title: ManagementUnit
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
+ | **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
12
13
  | **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
13
14
  | **time_zone** | **String** | The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database) | [optional] |
14
15
  | **settings** | [**ManagementUnitSettings**](ManagementUnitSettings.html) | The configuration settings for this management unit | [optional] |
@@ -18,6 +18,7 @@ title: MessageData
18
18
  | **text_body** | **String** | The body of the text message. | |
19
19
  | **status** | **String** | The status of the message. | |
20
20
  | **media** | [**Array<MessageMedia>**](MessageMedia.html) | The media details associated to a message. | [optional] |
21
+ | **stickers** | [**Array<MessageSticker>**](MessageSticker.html) | The sticker details associated to a message. | [optional] |
21
22
  | **created_by** | [**User**](User.html) | User who sent this message. | [optional] |
22
23
  | **self_uri** | **String** | The URI for this object | [optional] |
23
24
  {: class="table table-striped"}
@@ -13,6 +13,7 @@ title: MessageDetails
13
13
  | **message_segment_count** | **Integer** | The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. | [optional] |
14
14
  | **message_time** | **DateTime** | The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
15
  | **media** | [**Array<MessageMedia>**](MessageMedia.html) | The media (images, files, etc) associated with this message, if any | [optional] |
16
+ | **stickers** | [**Array<MessageSticker>**](MessageSticker.html) | One or more stickers associated with this message, if any | [optional] |
16
17
  {: class="table table-striped"}
17
18
 
18
19
 
@@ -9,6 +9,9 @@ title: MessageMedia
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **url** | **String** | The location of the media, useful for retrieving it | [optional] |
11
11
  | **media_type** | **String** | The optional internet media type of the the media object. If null then the media type should be dictated by the url | [optional] |
12
+ | **content_length_bytes** | **Integer** | The optional content length of the the media object, in bytes. | [optional] |
13
+ | **name** | **String** | The optional name of the the media object. | [optional] |
14
+ | **id** | **String** | The optional id of the the media object. | [optional] |
12
15
  {: class="table table-striped"}
13
16
 
14
17
 
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: MessageMediaData
3
+ ---
4
+ ## PureCloud::MessageMediaData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **url** | **String** | The location of the media, useful for retrieving it | [optional] |
13
+ | **media_type** | **String** | The optional internet media type of the the media object. If null then the media type should be dictated by the url. | [optional] |
14
+ | **content_length_bytes** | **Integer** | The optional content length of the the media object, in bytes. | [optional] |
15
+ | **upload_url** | **String** | The URL returned to upload an attachment | [optional] |
16
+ | **status** | **String** | The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid | [optional] |
17
+ | **self_uri** | **String** | The URI for this object | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: MessageSticker
3
+ ---
4
+ ## PureCloud::MessageSticker
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **url** | **String** | The location of the sticker, useful for retrieving it | [optional] |
11
+ | **id** | **String** | The unique id of the the sticker object. | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -31,7 +31,6 @@ Requires NO permissions:
31
31
 
32
32
 
33
33
 
34
-
35
34
  ### Example
36
35
  ~~~ruby
37
36
  # load the gem
@@ -95,7 +94,6 @@ Requires NO permissions:
95
94
 
96
95
 
97
96
 
98
-
99
97
  ### Example
100
98
  ~~~ruby
101
99
  # load the gem
@@ -160,7 +158,6 @@ Requires NO permissions:
160
158
 
161
159
 
162
160
 
163
-
164
161
  ### Example
165
162
  ~~~ruby
166
163
  # load the gem
@@ -230,7 +227,6 @@ Requires NO permissions:
230
227
 
231
228
 
232
229
 
233
-
234
230
  ### Example
235
231
  ~~~ruby
236
232
  # load the gem
@@ -295,7 +291,6 @@ Requires NO permissions:
295
291
 
296
292
 
297
293
 
298
-
299
294
  ### Example
300
295
  ~~~ruby
301
296
  # load the gem
@@ -33,7 +33,6 @@ Requires NO permissions:
33
33
 
34
34
 
35
35
 
36
-
37
36
  ### Example
38
37
  ~~~ruby
39
38
  # load the gem
@@ -97,7 +96,6 @@ Requires NO permissions:
97
96
 
98
97
 
99
98
 
100
-
101
99
  ### Example
102
100
  ~~~ruby
103
101
  # load the gem
@@ -163,7 +161,6 @@ Requires NO permissions:
163
161
 
164
162
 
165
163
 
166
-
167
164
  ### Example
168
165
  ~~~ruby
169
166
  # load the gem
@@ -228,7 +225,6 @@ Requires NO permissions:
228
225
 
229
226
 
230
227
 
231
-
232
228
  ### Example
233
229
  ~~~ruby
234
230
  # load the gem
@@ -294,7 +290,6 @@ Requires NO permissions:
294
290
 
295
291
 
296
292
 
297
-
298
293
  ### Example
299
294
  ~~~ruby
300
295
  # load the gem
@@ -362,7 +357,6 @@ Requires NO permissions:
362
357
 
363
358
 
364
359
 
365
-
366
360
  ### Example
367
361
  ~~~ruby
368
362
  # load the gem
@@ -421,7 +415,6 @@ Requires NO permissions:
421
415
 
422
416
 
423
417
 
424
-
425
418
  ### Example
426
419
  ~~~ruby
427
420
  # load the gem
@@ -30,7 +30,6 @@ Requires NO permissions:
30
30
 
31
31
 
32
32
 
33
-
34
33
  ### Example
35
34
  ~~~ruby
36
35
  # load the gem
@@ -95,7 +94,6 @@ Requires NO permissions:
95
94
 
96
95
 
97
96
 
98
-
99
97
  ### Example
100
98
  ~~~ruby
101
99
  # load the gem
@@ -111,7 +111,9 @@ Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUser
111
111
 
112
112
  Requires ANY permissions:
113
113
 
114
- * authorization:orgTrusteeUser:delete* admin* role_manager
114
+ * authorization:orgTrusteeUser:delete
115
+ * admin
116
+ * role_manager
115
117
 
116
118
 
117
119
  ### Example
@@ -178,7 +180,9 @@ Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUser
178
180
 
179
181
  Requires ANY permissions:
180
182
 
181
- * authorization:orgTrusteeUser:delete* admin* role_manager
183
+ * authorization:orgTrusteeUser:delete
184
+ * admin
185
+ * role_manager
182
186
 
183
187
 
184
188
  ### Example
@@ -376,7 +380,8 @@ Wraps GET /api/v2/orgauthorization/pairings/{pairingId}
376
380
 
377
381
  Requires ANY permissions:
378
382
 
379
- * authorization:orgTrustee:view* authorization:orgTrustor:view
383
+ * authorization:orgTrustee:view
384
+ * authorization:orgTrustor:view
380
385
 
381
386
 
382
387
  ### Example
@@ -1118,7 +1123,9 @@ Wraps POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users
1118
1123
 
1119
1124
  Requires ALL permissions:
1120
1125
 
1121
- * authorization:orgTrusteeUser:add* admin* role_manager
1126
+ * authorization:orgTrusteeUser:add
1127
+ * admin
1128
+ * role_manager
1122
1129
 
1123
1130
 
1124
1131
  ### Example
@@ -1186,7 +1193,8 @@ Wraps POST /api/v2/orgauthorization/trustees
1186
1193
 
1187
1194
  Requires ALL permissions:
1188
1195
 
1189
- * authorization:orgTrustee:add* authorization:orgTrusteeUser:add
1196
+ * authorization:orgTrustee:add
1197
+ * authorization:orgTrusteeUser:add
1190
1198
 
1191
1199
 
1192
1200
  ### Example
@@ -1469,7 +1477,9 @@ Wraps PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}
1469
1477
 
1470
1478
  Requires ANY permissions:
1471
1479
 
1472
- * authorization:orgTrusteeUser:edit* admin* role_manager
1480
+ * authorization:orgTrusteeUser:edit
1481
+ * admin
1482
+ * role_manager
1473
1483
 
1474
1484
 
1475
1485
  ### Example
@@ -2337,7 +2337,8 @@ Wraps GET /api/v2/outbound/contactlists/{contactListId}/export
2337
2337
 
2338
2338
  Requires ALL permissions:
2339
2339
 
2340
- * outbound:contact:view* outbound:contactList:view
2340
+ * outbound:contact:view
2341
+ * outbound:contactList:view
2341
2342
 
2342
2343
 
2343
2344
  ### Example
@@ -2767,7 +2768,8 @@ Wraps GET /api/v2/outbound/dnclists/{dncListId}/export
2767
2768
 
2768
2769
  Requires ALL permissions:
2769
2770
 
2770
- * outbound:dnc:view* outbound:dncList:view
2771
+ * outbound:dnc:view
2772
+ * outbound:dncList:view
2771
2773
 
2772
2774
 
2773
2775
  ### Example
@@ -4110,7 +4112,6 @@ Requires NO permissions:
4110
4112
 
4111
4113
 
4112
4114
 
4113
-
4114
4115
  ### Example
4115
4116
  ~~~ruby
4116
4117
  # load the gem
@@ -4515,7 +4516,8 @@ Wraps POST /api/v2/outbound/contactlists/{contactListId}/export
4515
4516
 
4516
4517
  Requires ALL permissions:
4517
4518
 
4518
- * outbound:contact:view* outbound:contactList:view
4519
+ * outbound:contact:view
4520
+ * outbound:contactList:view
4519
4521
 
4520
4522
 
4521
4523
  ### Example
@@ -4839,7 +4841,8 @@ Wraps POST /api/v2/outbound/dnclists/{dncListId}/export
4839
4841
 
4840
4842
  Requires ALL permissions:
4841
4843
 
4842
- * outbound:dnc:view* outbound:dncList:view
4844
+ * outbound:dnc:view
4845
+ * outbound:dncList:view
4843
4846
 
4844
4847
 
4845
4848
  ### Example
@@ -5440,7 +5443,6 @@ Requires NO permissions:
5440
5443
 
5441
5444
 
5442
5445
 
5443
-
5444
5446
  ### Example
5445
5447
  ~~~ruby
5446
5448
  # load the gem
@@ -13,6 +13,7 @@ title: OutboundSettings
13
13
  | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
15
15
  | **max_calls_per_agent** | **Integer** | The maximum number of calls that can be placed per agent on any campaign | [optional] |
16
+ | **max_configurable_calls_per_agent** | **Integer** | The maximum number of calls that can be configured to be placed per agent on any campaign | [optional] |
16
17
  | **max_line_utilization** | **Float** | The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0] | [optional] |
17
18
  | **abandon_seconds** | **Float** | The number of seconds used to determine if a call is abandoned | [optional] |
18
19
  | **compliance_abandon_rate_denominator** | **String** | The denominator to be used in determining the compliance abandon rate | [optional] |
@@ -98,7 +98,6 @@ Requires NO permissions:
98
98
 
99
99
 
100
100
 
101
-
102
101
  ### Example
103
102
  ~~~ruby
104
103
  # load the gem
@@ -167,7 +166,6 @@ Requires NO permissions:
167
166
 
168
167
 
169
168
 
170
-
171
169
  ### Example
172
170
  ~~~ruby
173
171
  # load the gem
@@ -239,7 +237,6 @@ Requires NO permissions:
239
237
 
240
238
 
241
239
 
242
-
243
240
  ### Example
244
241
  ~~~ruby
245
242
  # load the gem
@@ -298,7 +295,6 @@ Requires NO permissions:
298
295
 
299
296
 
300
297
 
301
-
302
298
  ### Example
303
299
  ~~~ruby
304
300
  # load the gem
@@ -366,7 +362,6 @@ Requires NO permissions:
366
362
 
367
363
 
368
364
 
369
-
370
365
  ### Example
371
366
  ~~~ruby
372
367
  # load the gem