purecloudplatformclientv2 35.0.0 → 36.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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AdditionalMessage.md +2 -0
- data/docs/AlertingApi.md +0 -2
- data/docs/AnalyticsApi.md +0 -13
- data/docs/ArchitectApi.md +210 -150
- data/docs/AttributesApi.md +0 -6
- data/docs/AuthorizationApi.md +15 -7
- data/docs/BillingApi.md +4 -1
- data/docs/CampaignDivisionView.md +1 -1
- data/docs/ContentManagementApi.md +0 -38
- data/docs/ConversationsApi.md +141 -75
- data/docs/CreateQueueRequest.md +1 -1
- data/docs/Division.md +15 -0
- data/docs/FaxApi.md +0 -6
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionView.md +1 -0
- data/docs/FreeSeatingConfiguration.md +1 -1
- data/docs/GeolocationApi.md +0 -3
- data/docs/GreetingsApi.md +0 -16
- data/docs/GroupsApi.md +2 -12
- data/docs/IdentityProviderApi.md +18 -9
- data/docs/IntegrationsApi.md +26 -31
- data/docs/LanguagesApi.md +0 -4
- data/docs/LicenseApi.md +21 -8
- data/docs/LocationsApi.md +0 -3
- data/docs/ManagementUnit.md +1 -0
- data/docs/MessageData.md +1 -0
- data/docs/MessageDetails.md +1 -0
- data/docs/MessageMedia.md +3 -0
- data/docs/MessageMediaData.md +20 -0
- data/docs/MessageSticker.md +14 -0
- data/docs/MobileDevicesApi.md +0 -5
- data/docs/NotificationsApi.md +0 -7
- data/docs/OrganizationApi.md +0 -2
- data/docs/OrganizationAuthorizationApi.md +16 -6
- data/docs/OutboundApi.md +8 -6
- data/docs/OutboundSettings.md +1 -0
- data/docs/PresenceApi.md +0 -5
- data/docs/QualityApi.md +0 -21
- data/docs/Queue.md +1 -1
- data/docs/RecordingApi.md +0 -17
- data/docs/ResponseManagementApi.md +0 -11
- data/docs/RoutingApi.md +93 -9
- data/docs/SearchApi.md +0 -14
- data/docs/StationsApi.md +0 -3
- data/docs/SuggestApi.md +0 -4
- data/docs/SurveyForm.md +3 -1
- data/docs/TelephonyProvidersEdgeApi.md +4 -16
- data/docs/TokensApi.md +0 -2
- data/docs/UserQueue.md +1 -1
- data/docs/UserRecordingsApi.md +0 -6
- data/docs/UsersApi.md +31 -42
- data/docs/UtilitiesApi.md +0 -3
- data/docs/VoicemailApi.md +8 -21
- data/docs/WorkforceManagementApi.md +25 -4
- data/lib/purecloudplatformclientv2.rb +3 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +136 -102
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +160 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +122 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +22 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/additional_message.rb +60 -4
- data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/division.rb +253 -0
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +27 -1
- data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +23 -9
- data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
- data/lib/purecloudplatformclientv2/models/message_data.rb +29 -1
- data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
- data/lib/purecloudplatformclientv2/models/message_media.rb +82 -4
- data/lib/purecloudplatformclientv2/models/message_media_data.rb +411 -0
- data/lib/purecloudplatformclientv2/models/message_sticker.rb +228 -0
- data/lib/purecloudplatformclientv2/models/outbound_settings.rb +27 -1
- data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_form.rb +53 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 75b21b636cf2aba720acb06e4108e56e4e5ceeab
|
|
4
|
+
data.tar.gz: e88bc2876c207a0c74d3199fbf286158dc0ae1af
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3cec2f5f108920980968c63fe89771b44894aaa9ffcf0337d2c7b5d183360bdcfab23ea3eab12fe63fe117986173084ab338efe5d5c426116d0959898596f4ca
|
|
7
|
+
data.tar.gz: ee486089eb83bfb2958fb12012a483bcbea490cfc98feb8b51e4c3a748673d2cc7abf9ec78f5a6decef0f62aaf9e4f5735f162f3422cb839c7ad37f8da7a1c36
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-

|
|
5
5
|
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
|
10
10
|
### from rubygems.org
|
|
11
11
|
|
|
12
12
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 36.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/AdditionalMessage.md
CHANGED
|
@@ -8,6 +8,8 @@ title: AdditionalMessage
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **text_body** | **String** | The body of the text message. | |
|
|
11
|
+
| **media_ids** | **Array<String>** | The media ids associated with the text message. | [optional] |
|
|
12
|
+
| **sticker_ids** | **Array<String>** | The sticker ids associated with the text message. | [optional] |
|
|
11
13
|
{: class="table table-striped"}
|
|
12
14
|
|
|
13
15
|
|
data/docs/AlertingApi.md
CHANGED
data/docs/AnalyticsApi.md
CHANGED
|
@@ -50,7 +50,6 @@ Requires NO permissions:
|
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
|
53
|
-
|
|
54
53
|
### Example
|
|
55
54
|
~~~ruby
|
|
56
55
|
# load the gem
|
|
@@ -238,7 +237,6 @@ Requires NO permissions:
|
|
|
238
237
|
|
|
239
238
|
|
|
240
239
|
|
|
241
|
-
|
|
242
240
|
### Example
|
|
243
241
|
~~~ruby
|
|
244
242
|
# load the gem
|
|
@@ -308,7 +306,6 @@ Requires NO permissions:
|
|
|
308
306
|
|
|
309
307
|
|
|
310
308
|
|
|
311
|
-
|
|
312
309
|
### Example
|
|
313
310
|
~~~ruby
|
|
314
311
|
# load the gem
|
|
@@ -377,7 +374,6 @@ Requires NO permissions:
|
|
|
377
374
|
|
|
378
375
|
|
|
379
376
|
|
|
380
|
-
|
|
381
377
|
### Example
|
|
382
378
|
~~~ruby
|
|
383
379
|
# load the gem
|
|
@@ -436,7 +432,6 @@ Requires NO permissions:
|
|
|
436
432
|
|
|
437
433
|
|
|
438
434
|
|
|
439
|
-
|
|
440
435
|
### Example
|
|
441
436
|
~~~ruby
|
|
442
437
|
# load the gem
|
|
@@ -501,7 +496,6 @@ Requires NO permissions:
|
|
|
501
496
|
|
|
502
497
|
|
|
503
498
|
|
|
504
|
-
|
|
505
499
|
### Example
|
|
506
500
|
~~~ruby
|
|
507
501
|
# load the gem
|
|
@@ -572,7 +566,6 @@ Requires NO permissions:
|
|
|
572
566
|
|
|
573
567
|
|
|
574
568
|
|
|
575
|
-
|
|
576
569
|
### Example
|
|
577
570
|
~~~ruby
|
|
578
571
|
# load the gem
|
|
@@ -637,7 +630,6 @@ Requires NO permissions:
|
|
|
637
630
|
|
|
638
631
|
|
|
639
632
|
|
|
640
|
-
|
|
641
633
|
### Example
|
|
642
634
|
~~~ruby
|
|
643
635
|
# load the gem
|
|
@@ -705,7 +697,6 @@ Requires NO permissions:
|
|
|
705
697
|
|
|
706
698
|
|
|
707
699
|
|
|
708
|
-
|
|
709
700
|
### Example
|
|
710
701
|
~~~ruby
|
|
711
702
|
# load the gem
|
|
@@ -773,7 +764,6 @@ Requires NO permissions:
|
|
|
773
764
|
|
|
774
765
|
|
|
775
766
|
|
|
776
|
-
|
|
777
767
|
### Example
|
|
778
768
|
~~~ruby
|
|
779
769
|
# load the gem
|
|
@@ -1225,7 +1215,6 @@ Requires NO permissions:
|
|
|
1225
1215
|
|
|
1226
1216
|
|
|
1227
1217
|
|
|
1228
|
-
|
|
1229
1218
|
### Example
|
|
1230
1219
|
~~~ruby
|
|
1231
1220
|
# load the gem
|
|
@@ -1290,7 +1279,6 @@ Requires NO permissions:
|
|
|
1290
1279
|
|
|
1291
1280
|
|
|
1292
1281
|
|
|
1293
|
-
|
|
1294
1282
|
### Example
|
|
1295
1283
|
~~~ruby
|
|
1296
1284
|
# load the gem
|
|
@@ -1550,7 +1538,6 @@ Requires NO permissions:
|
|
|
1550
1538
|
|
|
1551
1539
|
|
|
1552
1540
|
|
|
1553
|
-
|
|
1554
1541
|
### Example
|
|
1555
1542
|
~~~ruby
|
|
1556
1543
|
# load the gem
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -233,7 +233,8 @@ Wraps DELETE /api/v2/architect/prompts/{promptId}
|
|
|
233
233
|
|
|
234
234
|
Requires ANY permissions:
|
|
235
235
|
|
|
236
|
-
* architect:user:admin
|
|
236
|
+
* architect:user:admin
|
|
237
|
+
* architect:user:editor
|
|
237
238
|
|
|
238
239
|
|
|
239
240
|
### Example
|
|
@@ -301,7 +302,8 @@ Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
|
|
301
302
|
|
|
302
303
|
Requires ANY permissions:
|
|
303
304
|
|
|
304
|
-
* architect:user:admin
|
|
305
|
+
* architect:user:admin
|
|
306
|
+
* architect:user:editor
|
|
305
307
|
|
|
306
308
|
|
|
307
309
|
### Example
|
|
@@ -368,7 +370,8 @@ Wraps DELETE /api/v2/architect/prompts
|
|
|
368
370
|
|
|
369
371
|
Requires ANY permissions:
|
|
370
372
|
|
|
371
|
-
* architect:user:admin
|
|
373
|
+
* architect:user:admin
|
|
374
|
+
* architect:user:editor
|
|
372
375
|
|
|
373
376
|
|
|
374
377
|
### Example
|
|
@@ -561,7 +564,8 @@ Wraps DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
|
|
561
564
|
|
|
562
565
|
Requires ANY permissions:
|
|
563
566
|
|
|
564
|
-
* architect:user:admin
|
|
567
|
+
* architect:user:admin
|
|
568
|
+
* architect:user:editor
|
|
565
569
|
|
|
566
570
|
|
|
567
571
|
### Example
|
|
@@ -628,7 +632,8 @@ Wraps DELETE /api/v2/flows/{flowId}
|
|
|
628
632
|
|
|
629
633
|
Requires ANY permissions:
|
|
630
634
|
|
|
631
|
-
* architect:user:admin
|
|
635
|
+
* architect:user:admin
|
|
636
|
+
* architect:user:editor
|
|
632
637
|
|
|
633
638
|
|
|
634
639
|
### Example
|
|
@@ -692,7 +697,8 @@ Wraps DELETE /api/v2/flows
|
|
|
692
697
|
|
|
693
698
|
Requires ANY permissions:
|
|
694
699
|
|
|
695
|
-
* architect:user:admin
|
|
700
|
+
* architect:user:admin
|
|
701
|
+
* architect:user:editor
|
|
696
702
|
|
|
697
703
|
|
|
698
704
|
### Example
|
|
@@ -892,7 +898,9 @@ Wraps GET /api/v2/architect/dependencytracking
|
|
|
892
898
|
|
|
893
899
|
Requires ANY permissions:
|
|
894
900
|
|
|
895
|
-
* architect:user:admin
|
|
901
|
+
* architect:user:admin
|
|
902
|
+
* architect:user:editor
|
|
903
|
+
* architect:user:readonly
|
|
896
904
|
|
|
897
905
|
|
|
898
906
|
### Example
|
|
@@ -973,7 +981,9 @@ Wraps GET /api/v2/architect/dependencytracking/build
|
|
|
973
981
|
|
|
974
982
|
Requires ANY permissions:
|
|
975
983
|
|
|
976
|
-
* architect:user:admin
|
|
984
|
+
* architect:user:admin
|
|
985
|
+
* architect:user:editor
|
|
986
|
+
* architect:user:readonly
|
|
977
987
|
|
|
978
988
|
|
|
979
989
|
### Example
|
|
@@ -1032,7 +1042,9 @@ Wraps GET /api/v2/architect/dependencytracking/consumedresources
|
|
|
1032
1042
|
|
|
1033
1043
|
Requires ANY permissions:
|
|
1034
1044
|
|
|
1035
|
-
* admin
|
|
1045
|
+
* admin
|
|
1046
|
+
* editor
|
|
1047
|
+
* readonly
|
|
1036
1048
|
|
|
1037
1049
|
|
|
1038
1050
|
### Example
|
|
@@ -1107,7 +1119,9 @@ Wraps GET /api/v2/architect/dependencytracking/consumingresources
|
|
|
1107
1119
|
|
|
1108
1120
|
Requires ANY permissions:
|
|
1109
1121
|
|
|
1110
|
-
* architect:user:admin
|
|
1122
|
+
* architect:user:admin
|
|
1123
|
+
* architect:user:editor
|
|
1124
|
+
* architect:user:readonly
|
|
1111
1125
|
|
|
1112
1126
|
|
|
1113
1127
|
### Example
|
|
@@ -1179,7 +1193,9 @@ Wraps GET /api/v2/architect/dependencytracking/deletedresourceconsumers
|
|
|
1179
1193
|
|
|
1180
1194
|
Requires ANY permissions:
|
|
1181
1195
|
|
|
1182
|
-
* architect:user:admin
|
|
1196
|
+
* architect:user:admin
|
|
1197
|
+
* architect:user:editor
|
|
1198
|
+
* architect:user:readonly
|
|
1183
1199
|
|
|
1184
1200
|
|
|
1185
1201
|
### Example
|
|
@@ -1257,7 +1273,9 @@ Wraps GET /api/v2/architect/dependencytracking/object
|
|
|
1257
1273
|
|
|
1258
1274
|
Requires ANY permissions:
|
|
1259
1275
|
|
|
1260
|
-
* architect:user:admin
|
|
1276
|
+
* architect:user:admin
|
|
1277
|
+
* architect:user:editor
|
|
1278
|
+
* architect:user:readonly
|
|
1261
1279
|
|
|
1262
1280
|
|
|
1263
1281
|
### Example
|
|
@@ -1336,7 +1354,9 @@ Wraps GET /api/v2/architect/dependencytracking/types/{typeId}
|
|
|
1336
1354
|
|
|
1337
1355
|
Requires ANY permissions:
|
|
1338
1356
|
|
|
1339
|
-
* architect:user:admin
|
|
1357
|
+
* architect:user:admin
|
|
1358
|
+
* architect:user:editor
|
|
1359
|
+
* architect:user:readonly
|
|
1340
1360
|
|
|
1341
1361
|
|
|
1342
1362
|
### Example
|
|
@@ -1401,7 +1421,9 @@ Wraps GET /api/v2/architect/dependencytracking/types
|
|
|
1401
1421
|
|
|
1402
1422
|
Requires ANY permissions:
|
|
1403
1423
|
|
|
1404
|
-
* architect:user:admin
|
|
1424
|
+
* architect:user:admin
|
|
1425
|
+
* architect:user:editor
|
|
1426
|
+
* architect:user:readonly
|
|
1405
1427
|
|
|
1406
1428
|
|
|
1407
1429
|
### Example
|
|
@@ -1469,7 +1491,9 @@ Wraps GET /api/v2/architect/dependencytracking/updatedresourceconsumers
|
|
|
1469
1491
|
|
|
1470
1492
|
Requires ANY permissions:
|
|
1471
1493
|
|
|
1472
|
-
* architect:user:admin
|
|
1494
|
+
* architect:user:admin
|
|
1495
|
+
* architect:user:editor
|
|
1496
|
+
* architect:user:readonly
|
|
1473
1497
|
|
|
1474
1498
|
|
|
1475
1499
|
### Example
|
|
@@ -1823,7 +1847,9 @@ Wraps GET /api/v2/architect/prompts/{promptId}
|
|
|
1823
1847
|
|
|
1824
1848
|
Requires ANY permissions:
|
|
1825
1849
|
|
|
1826
|
-
* architect:user:admin
|
|
1850
|
+
* architect:user:admin
|
|
1851
|
+
* architect:user:editor
|
|
1852
|
+
* architect:user:readonly
|
|
1827
1853
|
|
|
1828
1854
|
|
|
1829
1855
|
### Example
|
|
@@ -1888,7 +1914,9 @@ Wraps GET /api/v2/architect/prompts/{promptId}/history/{historyId}
|
|
|
1888
1914
|
|
|
1889
1915
|
Requires ANY permissions:
|
|
1890
1916
|
|
|
1891
|
-
* architect:user:admin
|
|
1917
|
+
* architect:user:admin
|
|
1918
|
+
* architect:user:editor
|
|
1919
|
+
* architect:user:readonly
|
|
1892
1920
|
|
|
1893
1921
|
|
|
1894
1922
|
### Example
|
|
@@ -1968,7 +1996,9 @@ Wraps GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
|
|
1968
1996
|
|
|
1969
1997
|
Requires ANY permissions:
|
|
1970
1998
|
|
|
1971
|
-
* architect:user:admin
|
|
1999
|
+
* architect:user:admin
|
|
2000
|
+
* architect:user:editor
|
|
2001
|
+
* architect:user:readonly
|
|
1972
2002
|
|
|
1973
2003
|
|
|
1974
2004
|
### Example
|
|
@@ -2036,7 +2066,9 @@ Wraps GET /api/v2/architect/prompts/{promptId}/resources
|
|
|
2036
2066
|
|
|
2037
2067
|
Requires ANY permissions:
|
|
2038
2068
|
|
|
2039
|
-
* architect:user:admin
|
|
2069
|
+
* architect:user:admin
|
|
2070
|
+
* architect:user:editor
|
|
2071
|
+
* architect:user:readonly
|
|
2040
2072
|
|
|
2041
2073
|
|
|
2042
2074
|
### Example
|
|
@@ -2107,7 +2139,9 @@ Wraps GET /api/v2/architect/prompts
|
|
|
2107
2139
|
|
|
2108
2140
|
Requires ANY permissions:
|
|
2109
2141
|
|
|
2110
|
-
* architect:user:admin
|
|
2142
|
+
* architect:user:admin
|
|
2143
|
+
* architect:user:editor
|
|
2144
|
+
* architect:user:readonly
|
|
2111
2145
|
|
|
2112
2146
|
|
|
2113
2147
|
### Example
|
|
@@ -2463,7 +2497,9 @@ Wraps GET /api/v2/architect/systemprompts/{promptId}
|
|
|
2463
2497
|
|
|
2464
2498
|
Requires ANY permissions:
|
|
2465
2499
|
|
|
2466
|
-
* architect:user:admin
|
|
2500
|
+
* architect:user:admin
|
|
2501
|
+
* architect:user:editor
|
|
2502
|
+
* architect:user:readonly
|
|
2467
2503
|
|
|
2468
2504
|
|
|
2469
2505
|
### Example
|
|
@@ -2528,7 +2564,9 @@ Wraps GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}
|
|
|
2528
2564
|
|
|
2529
2565
|
Requires ANY permissions:
|
|
2530
2566
|
|
|
2531
|
-
* architect:user:admin
|
|
2567
|
+
* architect:user:admin
|
|
2568
|
+
* architect:user:editor
|
|
2569
|
+
* architect:user:readonly
|
|
2532
2570
|
|
|
2533
2571
|
|
|
2534
2572
|
### Example
|
|
@@ -2608,7 +2646,9 @@ Wraps GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
|
|
2608
2646
|
|
|
2609
2647
|
Requires ANY permissions:
|
|
2610
2648
|
|
|
2611
|
-
* architect:user:admin
|
|
2649
|
+
* architect:user:admin
|
|
2650
|
+
* architect:user:editor
|
|
2651
|
+
* architect:user:readonly
|
|
2612
2652
|
|
|
2613
2653
|
|
|
2614
2654
|
### Example
|
|
@@ -2676,7 +2716,9 @@ Wraps GET /api/v2/architect/systemprompts/{promptId}/resources
|
|
|
2676
2716
|
|
|
2677
2717
|
Requires ANY permissions:
|
|
2678
2718
|
|
|
2679
|
-
* architect:user:admin
|
|
2719
|
+
* architect:user:admin
|
|
2720
|
+
* architect:user:editor
|
|
2721
|
+
* architect:user:readonly
|
|
2680
2722
|
|
|
2681
2723
|
|
|
2682
2724
|
### Example
|
|
@@ -2751,7 +2793,9 @@ Wraps GET /api/v2/architect/systemprompts
|
|
|
2751
2793
|
|
|
2752
2794
|
Requires ANY permissions:
|
|
2753
2795
|
|
|
2754
|
-
* architect:user:admin
|
|
2796
|
+
* architect:user:admin
|
|
2797
|
+
* architect:user:editor
|
|
2798
|
+
* architect:user:readonly
|
|
2755
2799
|
|
|
2756
2800
|
|
|
2757
2801
|
### Example
|
|
@@ -2829,7 +2873,9 @@ Wraps GET /api/v2/flows/{flowId}
|
|
|
2829
2873
|
|
|
2830
2874
|
Requires ANY permissions:
|
|
2831
2875
|
|
|
2832
|
-
* architect:user:admin
|
|
2876
|
+
* architect:user:admin
|
|
2877
|
+
* architect:user:editor
|
|
2878
|
+
* architect:user:readonly
|
|
2833
2879
|
|
|
2834
2880
|
|
|
2835
2881
|
### Example
|
|
@@ -2898,7 +2944,9 @@ Wraps GET /api/v2/flows/{flowId}/history/{historyId}
|
|
|
2898
2944
|
|
|
2899
2945
|
Requires ANY permissions:
|
|
2900
2946
|
|
|
2901
|
-
* architect:user:admin
|
|
2947
|
+
* architect:user:admin
|
|
2948
|
+
* architect:user:editor
|
|
2949
|
+
* architect:user:readonly
|
|
2902
2950
|
|
|
2903
2951
|
|
|
2904
2952
|
### Example
|
|
@@ -2978,7 +3026,9 @@ Wraps GET /api/v2/flows/{flowId}/latestconfiguration
|
|
|
2978
3026
|
|
|
2979
3027
|
Requires ANY permissions:
|
|
2980
3028
|
|
|
2981
|
-
* architect:user:admin
|
|
3029
|
+
* architect:user:admin
|
|
3030
|
+
* architect:user:editor
|
|
3031
|
+
* architect:user:readonly
|
|
2982
3032
|
|
|
2983
3033
|
|
|
2984
3034
|
### Example
|
|
@@ -3047,7 +3097,9 @@ Wraps GET /api/v2/flows/{flowId}/versions/{versionId}
|
|
|
3047
3097
|
|
|
3048
3098
|
Requires ANY permissions:
|
|
3049
3099
|
|
|
3050
|
-
* architect:user:admin
|
|
3100
|
+
* architect:user:admin
|
|
3101
|
+
* architect:user:editor
|
|
3102
|
+
* architect:user:readonly
|
|
3051
3103
|
|
|
3052
3104
|
|
|
3053
3105
|
### Example
|
|
@@ -3119,7 +3171,9 @@ Wraps GET /api/v2/flows/{flowId}/versions/{versionId}/configuration
|
|
|
3119
3171
|
|
|
3120
3172
|
Requires ANY permissions:
|
|
3121
3173
|
|
|
3122
|
-
* architect:user:admin
|
|
3174
|
+
* architect:user:admin
|
|
3175
|
+
* architect:user:editor
|
|
3176
|
+
* architect:user:readonly
|
|
3123
3177
|
|
|
3124
3178
|
|
|
3125
3179
|
### Example
|
|
@@ -3191,7 +3245,9 @@ Wraps GET /api/v2/flows/{flowId}/versions
|
|
|
3191
3245
|
|
|
3192
3246
|
Requires ANY permissions:
|
|
3193
3247
|
|
|
3194
|
-
* architect:user:admin
|
|
3248
|
+
* architect:user:admin
|
|
3249
|
+
* architect:user:editor
|
|
3250
|
+
* architect:user:readonly
|
|
3195
3251
|
|
|
3196
3252
|
|
|
3197
3253
|
### Example
|
|
@@ -3264,7 +3320,9 @@ Wraps GET /api/v2/flows
|
|
|
3264
3320
|
|
|
3265
3321
|
Requires ANY permissions:
|
|
3266
3322
|
|
|
3267
|
-
* architect:user:admin
|
|
3323
|
+
* architect:user:admin
|
|
3324
|
+
* architect:user:editor
|
|
3325
|
+
* architect:user:readonly
|
|
3268
3326
|
|
|
3269
3327
|
|
|
3270
3328
|
### Example
|
|
@@ -3786,7 +3844,7 @@ nil (empty response body)
|
|
|
3786
3844
|
|
|
3787
3845
|
<a name="post_architect_emergencygroups"></a>
|
|
3788
3846
|
|
|
3789
|
-
## -[**EmergencyGroup**](EmergencyGroup.html) post_architect_emergencygroups(
|
|
3847
|
+
## -[**EmergencyGroup**](EmergencyGroup.html) post_architect_emergencygroups(body)
|
|
3790
3848
|
|
|
3791
3849
|
|
|
3792
3850
|
|
|
@@ -3818,13 +3876,12 @@ end
|
|
|
3818
3876
|
|
|
3819
3877
|
api_instance = PureCloud::ArchitectApi.new
|
|
3820
3878
|
|
|
3821
|
-
|
|
3822
|
-
|
|
3823
|
-
}
|
|
3879
|
+
body = PureCloud::EmergencyGroup.new # EmergencyGroup |
|
|
3880
|
+
|
|
3824
3881
|
|
|
3825
3882
|
begin
|
|
3826
3883
|
#Creates a new emergency group
|
|
3827
|
-
result = api_instance.post_architect_emergencygroups(
|
|
3884
|
+
result = api_instance.post_architect_emergencygroups(body)
|
|
3828
3885
|
p result
|
|
3829
3886
|
rescue PureCloud::ApiError => e
|
|
3830
3887
|
puts "Exception when calling ArchitectApi->post_architect_emergencygroups: #{e}"
|
|
@@ -3835,7 +3892,7 @@ end
|
|
|
3835
3892
|
|
|
3836
3893
|
Name | Type | Description | Notes
|
|
3837
3894
|
------------- | ------------- | ------------- | -------------
|
|
3838
|
-
**body** | [**EmergencyGroup**](EmergencyGroup.html)| |
|
|
3895
|
+
**body** | [**EmergencyGroup**](EmergencyGroup.html)| | |
|
|
3839
3896
|
{: class="table table-striped"}
|
|
3840
3897
|
|
|
3841
3898
|
|
|
@@ -3852,7 +3909,7 @@ Name | Type | Description | Notes
|
|
|
3852
3909
|
|
|
3853
3910
|
<a name="post_architect_ivrs"></a>
|
|
3854
3911
|
|
|
3855
|
-
## -[**IVR**](IVR.html) post_architect_ivrs(
|
|
3912
|
+
## -[**IVR**](IVR.html) post_architect_ivrs(body)
|
|
3856
3913
|
|
|
3857
3914
|
|
|
3858
3915
|
|
|
@@ -3884,13 +3941,12 @@ end
|
|
|
3884
3941
|
|
|
3885
3942
|
api_instance = PureCloud::ArchitectApi.new
|
|
3886
3943
|
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
}
|
|
3944
|
+
body = PureCloud::IVR.new # IVR |
|
|
3945
|
+
|
|
3890
3946
|
|
|
3891
3947
|
begin
|
|
3892
3948
|
#Create IVR config.
|
|
3893
|
-
result = api_instance.post_architect_ivrs(
|
|
3949
|
+
result = api_instance.post_architect_ivrs(body)
|
|
3894
3950
|
p result
|
|
3895
3951
|
rescue PureCloud::ApiError => e
|
|
3896
3952
|
puts "Exception when calling ArchitectApi->post_architect_ivrs: #{e}"
|
|
@@ -3901,7 +3957,7 @@ end
|
|
|
3901
3957
|
|
|
3902
3958
|
Name | Type | Description | Notes
|
|
3903
3959
|
------------- | ------------- | ------------- | -------------
|
|
3904
|
-
**body** | [**IVR**](IVR.html)| |
|
|
3960
|
+
**body** | [**IVR**](IVR.html)| | |
|
|
3905
3961
|
{: class="table table-striped"}
|
|
3906
3962
|
|
|
3907
3963
|
|
|
@@ -3930,7 +3986,9 @@ Wraps POST /api/v2/architect/prompts/{promptId}/history
|
|
|
3930
3986
|
|
|
3931
3987
|
Requires ANY permissions:
|
|
3932
3988
|
|
|
3933
|
-
* architect:user:admin
|
|
3989
|
+
* architect:user:admin
|
|
3990
|
+
* architect:user:editor
|
|
3991
|
+
* architect:user:readonly
|
|
3934
3992
|
|
|
3935
3993
|
|
|
3936
3994
|
### Example
|
|
@@ -3983,7 +4041,7 @@ Name | Type | Description | Notes
|
|
|
3983
4041
|
|
|
3984
4042
|
<a name="post_architect_prompt_resources"></a>
|
|
3985
4043
|
|
|
3986
|
-
## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id,
|
|
4044
|
+
## -[**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, body)
|
|
3987
4045
|
|
|
3988
4046
|
|
|
3989
4047
|
|
|
@@ -3995,7 +4053,8 @@ Wraps POST /api/v2/architect/prompts/{promptId}/resources
|
|
|
3995
4053
|
|
|
3996
4054
|
Requires ANY permissions:
|
|
3997
4055
|
|
|
3998
|
-
* architect:user:admin
|
|
4056
|
+
* architect:user:admin
|
|
4057
|
+
* architect:user:editor
|
|
3999
4058
|
|
|
4000
4059
|
|
|
4001
4060
|
### Example
|
|
@@ -4017,13 +4076,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
4017
4076
|
|
|
4018
4077
|
prompt_id = "prompt_id_example" # String | Prompt ID
|
|
4019
4078
|
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
}
|
|
4079
|
+
body = PureCloud::PromptAssetCreate.new # PromptAssetCreate |
|
|
4080
|
+
|
|
4023
4081
|
|
|
4024
4082
|
begin
|
|
4025
4083
|
#Create a new user prompt resource
|
|
4026
|
-
result = api_instance.post_architect_prompt_resources(prompt_id,
|
|
4084
|
+
result = api_instance.post_architect_prompt_resources(prompt_id, body)
|
|
4027
4085
|
p result
|
|
4028
4086
|
rescue PureCloud::ApiError => e
|
|
4029
4087
|
puts "Exception when calling ArchitectApi->post_architect_prompt_resources: #{e}"
|
|
@@ -4035,7 +4093,7 @@ end
|
|
|
4035
4093
|
Name | Type | Description | Notes
|
|
4036
4094
|
------------- | ------------- | ------------- | -------------
|
|
4037
4095
|
**prompt_id** | **String**| Prompt ID | |
|
|
4038
|
-
**body** | [**PromptAssetCreate**](PromptAssetCreate.html)| |
|
|
4096
|
+
**body** | [**PromptAssetCreate**](PromptAssetCreate.html)| | |
|
|
4039
4097
|
{: class="table table-striped"}
|
|
4040
4098
|
|
|
4041
4099
|
|
|
@@ -4052,7 +4110,7 @@ Name | Type | Description | Notes
|
|
|
4052
4110
|
|
|
4053
4111
|
<a name="post_architect_prompts"></a>
|
|
4054
4112
|
|
|
4055
|
-
## -[**Prompt**](Prompt.html) post_architect_prompts(
|
|
4113
|
+
## -[**Prompt**](Prompt.html) post_architect_prompts(body)
|
|
4056
4114
|
|
|
4057
4115
|
|
|
4058
4116
|
|
|
@@ -4064,7 +4122,8 @@ Wraps POST /api/v2/architect/prompts
|
|
|
4064
4122
|
|
|
4065
4123
|
Requires ANY permissions:
|
|
4066
4124
|
|
|
4067
|
-
* architect:user:admin
|
|
4125
|
+
* architect:user:admin
|
|
4126
|
+
* architect:user:editor
|
|
4068
4127
|
|
|
4069
4128
|
|
|
4070
4129
|
### Example
|
|
@@ -4084,13 +4143,12 @@ end
|
|
|
4084
4143
|
|
|
4085
4144
|
api_instance = PureCloud::ArchitectApi.new
|
|
4086
4145
|
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
}
|
|
4146
|
+
body = PureCloud::Prompt.new # Prompt |
|
|
4147
|
+
|
|
4090
4148
|
|
|
4091
4149
|
begin
|
|
4092
4150
|
#Create a new user prompt
|
|
4093
|
-
result = api_instance.post_architect_prompts(
|
|
4151
|
+
result = api_instance.post_architect_prompts(body)
|
|
4094
4152
|
p result
|
|
4095
4153
|
rescue PureCloud::ApiError => e
|
|
4096
4154
|
puts "Exception when calling ArchitectApi->post_architect_prompts: #{e}"
|
|
@@ -4101,7 +4159,7 @@ end
|
|
|
4101
4159
|
|
|
4102
4160
|
Name | Type | Description | Notes
|
|
4103
4161
|
------------- | ------------- | ------------- | -------------
|
|
4104
|
-
**body** | [**Prompt**](Prompt.html)| |
|
|
4162
|
+
**body** | [**Prompt**](Prompt.html)| | |
|
|
4105
4163
|
{: class="table table-striped"}
|
|
4106
4164
|
|
|
4107
4165
|
|
|
@@ -4118,7 +4176,7 @@ Name | Type | Description | Notes
|
|
|
4118
4176
|
|
|
4119
4177
|
<a name="post_architect_schedulegroups"></a>
|
|
4120
4178
|
|
|
4121
|
-
## -[**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(
|
|
4179
|
+
## -[**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(body)
|
|
4122
4180
|
|
|
4123
4181
|
|
|
4124
4182
|
|
|
@@ -4150,13 +4208,12 @@ end
|
|
|
4150
4208
|
|
|
4151
4209
|
api_instance = PureCloud::ArchitectApi.new
|
|
4152
4210
|
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
}
|
|
4211
|
+
body = PureCloud::ScheduleGroup.new # ScheduleGroup |
|
|
4212
|
+
|
|
4156
4213
|
|
|
4157
4214
|
begin
|
|
4158
4215
|
#Creates a new schedule group
|
|
4159
|
-
result = api_instance.post_architect_schedulegroups(
|
|
4216
|
+
result = api_instance.post_architect_schedulegroups(body)
|
|
4160
4217
|
p result
|
|
4161
4218
|
rescue PureCloud::ApiError => e
|
|
4162
4219
|
puts "Exception when calling ArchitectApi->post_architect_schedulegroups: #{e}"
|
|
@@ -4167,7 +4224,7 @@ end
|
|
|
4167
4224
|
|
|
4168
4225
|
Name | Type | Description | Notes
|
|
4169
4226
|
------------- | ------------- | ------------- | -------------
|
|
4170
|
-
**body** | [**ScheduleGroup**](ScheduleGroup.html)| |
|
|
4227
|
+
**body** | [**ScheduleGroup**](ScheduleGroup.html)| | |
|
|
4171
4228
|
{: class="table table-striped"}
|
|
4172
4229
|
|
|
4173
4230
|
|
|
@@ -4184,7 +4241,7 @@ Name | Type | Description | Notes
|
|
|
4184
4241
|
|
|
4185
4242
|
<a name="post_architect_schedules"></a>
|
|
4186
4243
|
|
|
4187
|
-
## -[**Schedule**](Schedule.html) post_architect_schedules(
|
|
4244
|
+
## -[**Schedule**](Schedule.html) post_architect_schedules(body)
|
|
4188
4245
|
|
|
4189
4246
|
|
|
4190
4247
|
|
|
@@ -4216,13 +4273,12 @@ end
|
|
|
4216
4273
|
|
|
4217
4274
|
api_instance = PureCloud::ArchitectApi.new
|
|
4218
4275
|
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
}
|
|
4276
|
+
body = PureCloud::Schedule.new # Schedule |
|
|
4277
|
+
|
|
4222
4278
|
|
|
4223
4279
|
begin
|
|
4224
4280
|
#Create a new schedule.
|
|
4225
|
-
result = api_instance.post_architect_schedules(
|
|
4281
|
+
result = api_instance.post_architect_schedules(body)
|
|
4226
4282
|
p result
|
|
4227
4283
|
rescue PureCloud::ApiError => e
|
|
4228
4284
|
puts "Exception when calling ArchitectApi->post_architect_schedules: #{e}"
|
|
@@ -4233,7 +4289,7 @@ end
|
|
|
4233
4289
|
|
|
4234
4290
|
Name | Type | Description | Notes
|
|
4235
4291
|
------------- | ------------- | ------------- | -------------
|
|
4236
|
-
**body** | [**Schedule**](Schedule.html)| |
|
|
4292
|
+
**body** | [**Schedule**](Schedule.html)| | |
|
|
4237
4293
|
{: class="table table-striped"}
|
|
4238
4294
|
|
|
4239
4295
|
|
|
@@ -4262,7 +4318,9 @@ Wraps POST /api/v2/architect/systemprompts/{promptId}/history
|
|
|
4262
4318
|
|
|
4263
4319
|
Requires ANY permissions:
|
|
4264
4320
|
|
|
4265
|
-
* architect:user:admin
|
|
4321
|
+
* architect:user:admin
|
|
4322
|
+
* architect:user:editor
|
|
4323
|
+
* architect:user:readonly
|
|
4266
4324
|
|
|
4267
4325
|
|
|
4268
4326
|
### Example
|
|
@@ -4315,7 +4373,7 @@ Name | Type | Description | Notes
|
|
|
4315
4373
|
|
|
4316
4374
|
<a name="post_architect_systemprompt_resources"></a>
|
|
4317
4375
|
|
|
4318
|
-
## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id,
|
|
4376
|
+
## -[**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, body)
|
|
4319
4377
|
|
|
4320
4378
|
|
|
4321
4379
|
|
|
@@ -4327,7 +4385,8 @@ Wraps POST /api/v2/architect/systemprompts/{promptId}/resources
|
|
|
4327
4385
|
|
|
4328
4386
|
Requires ANY permissions:
|
|
4329
4387
|
|
|
4330
|
-
* architect:user:admin
|
|
4388
|
+
* architect:user:admin
|
|
4389
|
+
* architect:user:editor
|
|
4331
4390
|
|
|
4332
4391
|
|
|
4333
4392
|
### Example
|
|
@@ -4349,13 +4408,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
4349
4408
|
|
|
4350
4409
|
prompt_id = "prompt_id_example" # String | Prompt ID
|
|
4351
4410
|
|
|
4352
|
-
|
|
4353
|
-
|
|
4354
|
-
}
|
|
4411
|
+
body = PureCloud::SystemPromptAsset.new # SystemPromptAsset |
|
|
4412
|
+
|
|
4355
4413
|
|
|
4356
4414
|
begin
|
|
4357
4415
|
#Create system prompt resource override.
|
|
4358
|
-
result = api_instance.post_architect_systemprompt_resources(prompt_id,
|
|
4416
|
+
result = api_instance.post_architect_systemprompt_resources(prompt_id, body)
|
|
4359
4417
|
p result
|
|
4360
4418
|
rescue PureCloud::ApiError => e
|
|
4361
4419
|
puts "Exception when calling ArchitectApi->post_architect_systemprompt_resources: #{e}"
|
|
@@ -4367,7 +4425,7 @@ end
|
|
|
4367
4425
|
Name | Type | Description | Notes
|
|
4368
4426
|
------------- | ------------- | ------------- | -------------
|
|
4369
4427
|
**prompt_id** | **String**| Prompt ID | |
|
|
4370
|
-
**body** | [**SystemPromptAsset**](SystemPromptAsset.html)| |
|
|
4428
|
+
**body** | [**SystemPromptAsset**](SystemPromptAsset.html)| | |
|
|
4371
4429
|
{: class="table table-striped"}
|
|
4372
4430
|
|
|
4373
4431
|
|
|
@@ -4384,7 +4442,7 @@ Name | Type | Description | Notes
|
|
|
4384
4442
|
|
|
4385
4443
|
<a name="post_flow_versions"></a>
|
|
4386
4444
|
|
|
4387
|
-
## -[**FlowVersion**](FlowVersion.html) post_flow_versions(flow_id,
|
|
4445
|
+
## -[**FlowVersion**](FlowVersion.html) post_flow_versions(flow_id, body)
|
|
4388
4446
|
|
|
4389
4447
|
|
|
4390
4448
|
|
|
@@ -4396,7 +4454,8 @@ Wraps POST /api/v2/flows/{flowId}/versions
|
|
|
4396
4454
|
|
|
4397
4455
|
Requires ANY permissions:
|
|
4398
4456
|
|
|
4399
|
-
* architect:user:admin
|
|
4457
|
+
* architect:user:admin
|
|
4458
|
+
* architect:user:editor
|
|
4400
4459
|
|
|
4401
4460
|
|
|
4402
4461
|
### Example
|
|
@@ -4418,13 +4477,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
4418
4477
|
|
|
4419
4478
|
flow_id = "flow_id_example" # String | Flow ID
|
|
4420
4479
|
|
|
4421
|
-
|
|
4422
|
-
|
|
4423
|
-
}
|
|
4480
|
+
body = nil # Object |
|
|
4481
|
+
|
|
4424
4482
|
|
|
4425
4483
|
begin
|
|
4426
4484
|
#Create flow version
|
|
4427
|
-
result = api_instance.post_flow_versions(flow_id,
|
|
4485
|
+
result = api_instance.post_flow_versions(flow_id, body)
|
|
4428
4486
|
p result
|
|
4429
4487
|
rescue PureCloud::ApiError => e
|
|
4430
4488
|
puts "Exception when calling ArchitectApi->post_flow_versions: #{e}"
|
|
@@ -4436,7 +4494,7 @@ end
|
|
|
4436
4494
|
Name | Type | Description | Notes
|
|
4437
4495
|
------------- | ------------- | ------------- | -------------
|
|
4438
4496
|
**flow_id** | **String**| Flow ID | |
|
|
4439
|
-
**body** | **Object**| |
|
|
4497
|
+
**body** | **Object**| | |
|
|
4440
4498
|
{: class="table table-striped"}
|
|
4441
4499
|
|
|
4442
4500
|
|
|
@@ -4453,7 +4511,7 @@ Name | Type | Description | Notes
|
|
|
4453
4511
|
|
|
4454
4512
|
<a name="post_flows"></a>
|
|
4455
4513
|
|
|
4456
|
-
## -[**Flow**](Flow.html) post_flows(
|
|
4514
|
+
## -[**Flow**](Flow.html) post_flows(body)
|
|
4457
4515
|
|
|
4458
4516
|
|
|
4459
4517
|
|
|
@@ -4465,7 +4523,9 @@ Wraps POST /api/v2/flows
|
|
|
4465
4523
|
|
|
4466
4524
|
Requires ANY permissions:
|
|
4467
4525
|
|
|
4468
|
-
* architect:user:admin
|
|
4526
|
+
* architect:user:admin
|
|
4527
|
+
* architect:user:editor
|
|
4528
|
+
* architect:user:readonly
|
|
4469
4529
|
|
|
4470
4530
|
|
|
4471
4531
|
### Example
|
|
@@ -4485,13 +4545,12 @@ end
|
|
|
4485
4545
|
|
|
4486
4546
|
api_instance = PureCloud::ArchitectApi.new
|
|
4487
4547
|
|
|
4488
|
-
|
|
4489
|
-
|
|
4490
|
-
}
|
|
4548
|
+
body = PureCloud::Flow.new # Flow |
|
|
4549
|
+
|
|
4491
4550
|
|
|
4492
4551
|
begin
|
|
4493
4552
|
#Create flow
|
|
4494
|
-
result = api_instance.post_flows(
|
|
4553
|
+
result = api_instance.post_flows(body)
|
|
4495
4554
|
p result
|
|
4496
4555
|
rescue PureCloud::ApiError => e
|
|
4497
4556
|
puts "Exception when calling ArchitectApi->post_flows: #{e}"
|
|
@@ -4502,7 +4561,7 @@ end
|
|
|
4502
4561
|
|
|
4503
4562
|
Name | Type | Description | Notes
|
|
4504
4563
|
------------- | ------------- | ------------- | -------------
|
|
4505
|
-
**body** | [**Flow**](Flow.html)| |
|
|
4564
|
+
**body** | [**Flow**](Flow.html)| | |
|
|
4506
4565
|
{: class="table table-striped"}
|
|
4507
4566
|
|
|
4508
4567
|
|
|
@@ -4531,7 +4590,8 @@ Wraps POST /api/v2/flows/actions/checkin
|
|
|
4531
4590
|
|
|
4532
4591
|
Requires ANY permissions:
|
|
4533
4592
|
|
|
4534
|
-
* architect:user:admin
|
|
4593
|
+
* architect:user:admin
|
|
4594
|
+
* architect:user:editor
|
|
4535
4595
|
|
|
4536
4596
|
|
|
4537
4597
|
### Example
|
|
@@ -4596,7 +4656,8 @@ Wraps POST /api/v2/flows/actions/checkout
|
|
|
4596
4656
|
|
|
4597
4657
|
Requires ANY permissions:
|
|
4598
4658
|
|
|
4599
|
-
* architect:user:admin
|
|
4659
|
+
* architect:user:admin
|
|
4660
|
+
* architect:user:editor
|
|
4600
4661
|
|
|
4601
4662
|
|
|
4602
4663
|
### Example
|
|
@@ -4661,7 +4722,8 @@ Wraps POST /api/v2/flows/actions/deactivate
|
|
|
4661
4722
|
|
|
4662
4723
|
Requires ANY permissions:
|
|
4663
4724
|
|
|
4664
|
-
* architect:user:admin
|
|
4725
|
+
* architect:user:admin
|
|
4726
|
+
* architect:user:editor
|
|
4665
4727
|
|
|
4666
4728
|
|
|
4667
4729
|
### Example
|
|
@@ -4726,7 +4788,8 @@ Wraps POST /api/v2/flows/actions/publish
|
|
|
4726
4788
|
|
|
4727
4789
|
Requires ANY permissions:
|
|
4728
4790
|
|
|
4729
|
-
* architect:user:admin
|
|
4791
|
+
* architect:user:admin
|
|
4792
|
+
* architect:user:editor
|
|
4730
4793
|
|
|
4731
4794
|
|
|
4732
4795
|
### Example
|
|
@@ -4795,7 +4858,8 @@ Wraps POST /api/v2/flows/actions/revert
|
|
|
4795
4858
|
|
|
4796
4859
|
Requires ANY permissions:
|
|
4797
4860
|
|
|
4798
|
-
* architect:user:admin
|
|
4861
|
+
* architect:user:admin
|
|
4862
|
+
* architect:user:editor
|
|
4799
4863
|
|
|
4800
4864
|
|
|
4801
4865
|
### Example
|
|
@@ -5046,7 +5110,7 @@ Name | Type | Description | Notes
|
|
|
5046
5110
|
|
|
5047
5111
|
<a name="put_architect_emergencygroup"></a>
|
|
5048
5112
|
|
|
5049
|
-
## -[**EmergencyGroup**](EmergencyGroup.html) put_architect_emergencygroup(emergency_group_id,
|
|
5113
|
+
## -[**EmergencyGroup**](EmergencyGroup.html) put_architect_emergencygroup(emergency_group_id, body)
|
|
5050
5114
|
|
|
5051
5115
|
|
|
5052
5116
|
|
|
@@ -5080,13 +5144,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5080
5144
|
|
|
5081
5145
|
emergency_group_id = "emergency_group_id_example" # String | Emergency group ID
|
|
5082
5146
|
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
}
|
|
5147
|
+
body = PureCloud::EmergencyGroup.new # EmergencyGroup |
|
|
5148
|
+
|
|
5086
5149
|
|
|
5087
5150
|
begin
|
|
5088
5151
|
#Updates a emergency group by ID
|
|
5089
|
-
result = api_instance.put_architect_emergencygroup(emergency_group_id,
|
|
5152
|
+
result = api_instance.put_architect_emergencygroup(emergency_group_id, body)
|
|
5090
5153
|
p result
|
|
5091
5154
|
rescue PureCloud::ApiError => e
|
|
5092
5155
|
puts "Exception when calling ArchitectApi->put_architect_emergencygroup: #{e}"
|
|
@@ -5098,7 +5161,7 @@ end
|
|
|
5098
5161
|
Name | Type | Description | Notes
|
|
5099
5162
|
------------- | ------------- | ------------- | -------------
|
|
5100
5163
|
**emergency_group_id** | **String**| Emergency group ID | |
|
|
5101
|
-
**body** | [**EmergencyGroup**](EmergencyGroup.html)| |
|
|
5164
|
+
**body** | [**EmergencyGroup**](EmergencyGroup.html)| | |
|
|
5102
5165
|
{: class="table table-striped"}
|
|
5103
5166
|
|
|
5104
5167
|
|
|
@@ -5115,7 +5178,7 @@ Name | Type | Description | Notes
|
|
|
5115
5178
|
|
|
5116
5179
|
<a name="put_architect_ivr"></a>
|
|
5117
5180
|
|
|
5118
|
-
## -[**IVR**](IVR.html) put_architect_ivr(ivr_id,
|
|
5181
|
+
## -[**IVR**](IVR.html) put_architect_ivr(ivr_id, body)
|
|
5119
5182
|
|
|
5120
5183
|
|
|
5121
5184
|
|
|
@@ -5149,13 +5212,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5149
5212
|
|
|
5150
5213
|
ivr_id = "ivr_id_example" # String | IVR id
|
|
5151
5214
|
|
|
5152
|
-
|
|
5153
|
-
|
|
5154
|
-
}
|
|
5215
|
+
body = PureCloud::IVR.new # IVR |
|
|
5216
|
+
|
|
5155
5217
|
|
|
5156
5218
|
begin
|
|
5157
5219
|
#Update an IVR Config.
|
|
5158
|
-
result = api_instance.put_architect_ivr(ivr_id,
|
|
5220
|
+
result = api_instance.put_architect_ivr(ivr_id, body)
|
|
5159
5221
|
p result
|
|
5160
5222
|
rescue PureCloud::ApiError => e
|
|
5161
5223
|
puts "Exception when calling ArchitectApi->put_architect_ivr: #{e}"
|
|
@@ -5167,7 +5229,7 @@ end
|
|
|
5167
5229
|
Name | Type | Description | Notes
|
|
5168
5230
|
------------- | ------------- | ------------- | -------------
|
|
5169
5231
|
**ivr_id** | **String**| IVR id | |
|
|
5170
|
-
**body** | [**IVR**](IVR.html)| |
|
|
5232
|
+
**body** | [**IVR**](IVR.html)| | |
|
|
5171
5233
|
{: class="table table-striped"}
|
|
5172
5234
|
|
|
5173
5235
|
|
|
@@ -5184,7 +5246,7 @@ Name | Type | Description | Notes
|
|
|
5184
5246
|
|
|
5185
5247
|
<a name="put_architect_prompt"></a>
|
|
5186
5248
|
|
|
5187
|
-
## -[**Prompt**](Prompt.html) put_architect_prompt(prompt_id,
|
|
5249
|
+
## -[**Prompt**](Prompt.html) put_architect_prompt(prompt_id, body)
|
|
5188
5250
|
|
|
5189
5251
|
|
|
5190
5252
|
|
|
@@ -5196,7 +5258,8 @@ Wraps PUT /api/v2/architect/prompts/{promptId}
|
|
|
5196
5258
|
|
|
5197
5259
|
Requires ANY permissions:
|
|
5198
5260
|
|
|
5199
|
-
* architect:user:admin
|
|
5261
|
+
* architect:user:admin
|
|
5262
|
+
* architect:user:editor
|
|
5200
5263
|
|
|
5201
5264
|
|
|
5202
5265
|
### Example
|
|
@@ -5218,13 +5281,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5218
5281
|
|
|
5219
5282
|
prompt_id = "prompt_id_example" # String | Prompt ID
|
|
5220
5283
|
|
|
5221
|
-
|
|
5222
|
-
|
|
5223
|
-
}
|
|
5284
|
+
body = PureCloud::Prompt.new # Prompt |
|
|
5285
|
+
|
|
5224
5286
|
|
|
5225
5287
|
begin
|
|
5226
5288
|
#Update specified user prompt
|
|
5227
|
-
result = api_instance.put_architect_prompt(prompt_id,
|
|
5289
|
+
result = api_instance.put_architect_prompt(prompt_id, body)
|
|
5228
5290
|
p result
|
|
5229
5291
|
rescue PureCloud::ApiError => e
|
|
5230
5292
|
puts "Exception when calling ArchitectApi->put_architect_prompt: #{e}"
|
|
@@ -5236,7 +5298,7 @@ end
|
|
|
5236
5298
|
Name | Type | Description | Notes
|
|
5237
5299
|
------------- | ------------- | ------------- | -------------
|
|
5238
5300
|
**prompt_id** | **String**| Prompt ID | |
|
|
5239
|
-
**body** | [**Prompt**](Prompt.html)| |
|
|
5301
|
+
**body** | [**Prompt**](Prompt.html)| | |
|
|
5240
5302
|
{: class="table table-striped"}
|
|
5241
5303
|
|
|
5242
5304
|
|
|
@@ -5253,7 +5315,7 @@ Name | Type | Description | Notes
|
|
|
5253
5315
|
|
|
5254
5316
|
<a name="put_architect_prompt_resource"></a>
|
|
5255
5317
|
|
|
5256
|
-
## -[**PromptAsset**](PromptAsset.html) put_architect_prompt_resource(prompt_id, language_code,
|
|
5318
|
+
## -[**PromptAsset**](PromptAsset.html) put_architect_prompt_resource(prompt_id, language_code, body)
|
|
5257
5319
|
|
|
5258
5320
|
|
|
5259
5321
|
|
|
@@ -5265,7 +5327,8 @@ Wraps PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
|
|
5265
5327
|
|
|
5266
5328
|
Requires ANY permissions:
|
|
5267
5329
|
|
|
5268
|
-
* architect:user:admin
|
|
5330
|
+
* architect:user:admin
|
|
5331
|
+
* architect:user:editor
|
|
5269
5332
|
|
|
5270
5333
|
|
|
5271
5334
|
### Example
|
|
@@ -5289,13 +5352,12 @@ prompt_id = "prompt_id_example" # String | Prompt ID
|
|
|
5289
5352
|
|
|
5290
5353
|
language_code = "language_code_example" # String | Language
|
|
5291
5354
|
|
|
5292
|
-
|
|
5293
|
-
|
|
5294
|
-
}
|
|
5355
|
+
body = PureCloud::PromptAsset.new # PromptAsset |
|
|
5356
|
+
|
|
5295
5357
|
|
|
5296
5358
|
begin
|
|
5297
5359
|
#Update specified user prompt resource
|
|
5298
|
-
result = api_instance.put_architect_prompt_resource(prompt_id, language_code,
|
|
5360
|
+
result = api_instance.put_architect_prompt_resource(prompt_id, language_code, body)
|
|
5299
5361
|
p result
|
|
5300
5362
|
rescue PureCloud::ApiError => e
|
|
5301
5363
|
puts "Exception when calling ArchitectApi->put_architect_prompt_resource: #{e}"
|
|
@@ -5308,7 +5370,7 @@ Name | Type | Description | Notes
|
|
|
5308
5370
|
------------- | ------------- | ------------- | -------------
|
|
5309
5371
|
**prompt_id** | **String**| Prompt ID | |
|
|
5310
5372
|
**language_code** | **String**| Language | |
|
|
5311
|
-
**body** | [**PromptAsset**](PromptAsset.html)| |
|
|
5373
|
+
**body** | [**PromptAsset**](PromptAsset.html)| | |
|
|
5312
5374
|
{: class="table table-striped"}
|
|
5313
5375
|
|
|
5314
5376
|
|
|
@@ -5325,7 +5387,7 @@ Name | Type | Description | Notes
|
|
|
5325
5387
|
|
|
5326
5388
|
<a name="put_architect_schedule"></a>
|
|
5327
5389
|
|
|
5328
|
-
## -[**Schedule**](Schedule.html) put_architect_schedule(schedule_id,
|
|
5390
|
+
## -[**Schedule**](Schedule.html) put_architect_schedule(schedule_id, body)
|
|
5329
5391
|
|
|
5330
5392
|
|
|
5331
5393
|
|
|
@@ -5359,13 +5421,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5359
5421
|
|
|
5360
5422
|
schedule_id = "schedule_id_example" # String | Schedule ID
|
|
5361
5423
|
|
|
5362
|
-
|
|
5363
|
-
|
|
5364
|
-
}
|
|
5424
|
+
body = PureCloud::Schedule.new # Schedule |
|
|
5425
|
+
|
|
5365
5426
|
|
|
5366
5427
|
begin
|
|
5367
5428
|
#Update schedule by ID
|
|
5368
|
-
result = api_instance.put_architect_schedule(schedule_id,
|
|
5429
|
+
result = api_instance.put_architect_schedule(schedule_id, body)
|
|
5369
5430
|
p result
|
|
5370
5431
|
rescue PureCloud::ApiError => e
|
|
5371
5432
|
puts "Exception when calling ArchitectApi->put_architect_schedule: #{e}"
|
|
@@ -5377,7 +5438,7 @@ end
|
|
|
5377
5438
|
Name | Type | Description | Notes
|
|
5378
5439
|
------------- | ------------- | ------------- | -------------
|
|
5379
5440
|
**schedule_id** | **String**| Schedule ID | |
|
|
5380
|
-
**body** | [**Schedule**](Schedule.html)| |
|
|
5441
|
+
**body** | [**Schedule**](Schedule.html)| | |
|
|
5381
5442
|
{: class="table table-striped"}
|
|
5382
5443
|
|
|
5383
5444
|
|
|
@@ -5394,7 +5455,7 @@ Name | Type | Description | Notes
|
|
|
5394
5455
|
|
|
5395
5456
|
<a name="put_architect_schedulegroup"></a>
|
|
5396
5457
|
|
|
5397
|
-
## -[**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id,
|
|
5458
|
+
## -[**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id, body)
|
|
5398
5459
|
|
|
5399
5460
|
|
|
5400
5461
|
|
|
@@ -5428,13 +5489,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5428
5489
|
|
|
5429
5490
|
schedule_group_id = "schedule_group_id_example" # String | Schedule group ID
|
|
5430
5491
|
|
|
5431
|
-
|
|
5432
|
-
|
|
5433
|
-
}
|
|
5492
|
+
body = PureCloud::ScheduleGroup.new # ScheduleGroup |
|
|
5493
|
+
|
|
5434
5494
|
|
|
5435
5495
|
begin
|
|
5436
5496
|
#Updates a schedule group by ID
|
|
5437
|
-
result = api_instance.put_architect_schedulegroup(schedule_group_id,
|
|
5497
|
+
result = api_instance.put_architect_schedulegroup(schedule_group_id, body)
|
|
5438
5498
|
p result
|
|
5439
5499
|
rescue PureCloud::ApiError => e
|
|
5440
5500
|
puts "Exception when calling ArchitectApi->put_architect_schedulegroup: #{e}"
|
|
@@ -5446,7 +5506,7 @@ end
|
|
|
5446
5506
|
Name | Type | Description | Notes
|
|
5447
5507
|
------------- | ------------- | ------------- | -------------
|
|
5448
5508
|
**schedule_group_id** | **String**| Schedule group ID | |
|
|
5449
|
-
**body** | [**ScheduleGroup**](ScheduleGroup.html)| |
|
|
5509
|
+
**body** | [**ScheduleGroup**](ScheduleGroup.html)| | |
|
|
5450
5510
|
{: class="table table-striped"}
|
|
5451
5511
|
|
|
5452
5512
|
|
|
@@ -5463,7 +5523,7 @@ Name | Type | Description | Notes
|
|
|
5463
5523
|
|
|
5464
5524
|
<a name="put_architect_systemprompt_resource"></a>
|
|
5465
5525
|
|
|
5466
|
-
## -[**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code,
|
|
5526
|
+
## -[**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code, body)
|
|
5467
5527
|
|
|
5468
5528
|
|
|
5469
5529
|
|
|
@@ -5475,7 +5535,8 @@ Wraps PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
|
|
5475
5535
|
|
|
5476
5536
|
Requires ANY permissions:
|
|
5477
5537
|
|
|
5478
|
-
* architect:user:admin
|
|
5538
|
+
* architect:user:admin
|
|
5539
|
+
* architect:user:editor
|
|
5479
5540
|
|
|
5480
5541
|
|
|
5481
5542
|
### Example
|
|
@@ -5499,13 +5560,12 @@ prompt_id = "prompt_id_example" # String | Prompt ID
|
|
|
5499
5560
|
|
|
5500
5561
|
language_code = "language_code_example" # String | Language
|
|
5501
5562
|
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
}
|
|
5563
|
+
body = PureCloud::SystemPromptAsset.new # SystemPromptAsset |
|
|
5564
|
+
|
|
5505
5565
|
|
|
5506
5566
|
begin
|
|
5507
5567
|
#Updates a system prompt resource override.
|
|
5508
|
-
result = api_instance.put_architect_systemprompt_resource(prompt_id, language_code,
|
|
5568
|
+
result = api_instance.put_architect_systemprompt_resource(prompt_id, language_code, body)
|
|
5509
5569
|
p result
|
|
5510
5570
|
rescue PureCloud::ApiError => e
|
|
5511
5571
|
puts "Exception when calling ArchitectApi->put_architect_systemprompt_resource: #{e}"
|
|
@@ -5518,7 +5578,7 @@ Name | Type | Description | Notes
|
|
|
5518
5578
|
------------- | ------------- | ------------- | -------------
|
|
5519
5579
|
**prompt_id** | **String**| Prompt ID | |
|
|
5520
5580
|
**language_code** | **String**| Language | |
|
|
5521
|
-
**body** | [**SystemPromptAsset**](SystemPromptAsset.html)| |
|
|
5581
|
+
**body** | [**SystemPromptAsset**](SystemPromptAsset.html)| | |
|
|
5522
5582
|
{: class="table table-striped"}
|
|
5523
5583
|
|
|
5524
5584
|
|
|
@@ -5535,7 +5595,7 @@ Name | Type | Description | Notes
|
|
|
5535
5595
|
|
|
5536
5596
|
<a name="put_flow"></a>
|
|
5537
5597
|
|
|
5538
|
-
## -[**Flow**](Flow.html) put_flow(flow_id,
|
|
5598
|
+
## -[**Flow**](Flow.html) put_flow(flow_id, body)
|
|
5539
5599
|
|
|
5540
5600
|
|
|
5541
5601
|
|
|
@@ -5547,7 +5607,8 @@ Wraps PUT /api/v2/flows/{flowId}
|
|
|
5547
5607
|
|
|
5548
5608
|
Requires ANY permissions:
|
|
5549
5609
|
|
|
5550
|
-
* architect:user:admin
|
|
5610
|
+
* architect:user:admin
|
|
5611
|
+
* architect:user:editor
|
|
5551
5612
|
|
|
5552
5613
|
|
|
5553
5614
|
### Example
|
|
@@ -5569,13 +5630,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
5569
5630
|
|
|
5570
5631
|
flow_id = "flow_id_example" # String | Flow ID
|
|
5571
5632
|
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
}
|
|
5633
|
+
body = PureCloud::Flow.new # Flow |
|
|
5634
|
+
|
|
5575
5635
|
|
|
5576
5636
|
begin
|
|
5577
5637
|
#Update flow
|
|
5578
|
-
result = api_instance.put_flow(flow_id,
|
|
5638
|
+
result = api_instance.put_flow(flow_id, body)
|
|
5579
5639
|
p result
|
|
5580
5640
|
rescue PureCloud::ApiError => e
|
|
5581
5641
|
puts "Exception when calling ArchitectApi->put_flow: #{e}"
|
|
@@ -5587,7 +5647,7 @@ end
|
|
|
5587
5647
|
Name | Type | Description | Notes
|
|
5588
5648
|
------------- | ------------- | ------------- | -------------
|
|
5589
5649
|
**flow_id** | **String**| Flow ID | |
|
|
5590
|
-
**body** | [**Flow**](Flow.html)| |
|
|
5650
|
+
**body** | [**Flow**](Flow.html)| | |
|
|
5591
5651
|
{: class="table table-striped"}
|
|
5592
5652
|
|
|
5593
5653
|
|