purecloudplatformclientv2 49.0.0 → 49.0.1
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 +8 -8
- data/docs/AlertingApi.md +33 -33
- data/docs/AnalyticsApi.md +81 -81
- data/docs/ArchitectApi.md +243 -243
- data/docs/AuthorizationApi.md +102 -102
- data/docs/BillingApi.md +6 -6
- data/docs/ContentManagementApi.md +114 -114
- data/docs/ConversationsApi.md +300 -300
- data/docs/DialerRulesetConfigChangeCondition.md +1 -0
- data/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +2 -0
- data/docs/ExternalContactsApi.md +90 -90
- data/docs/FaxApi.md +18 -18
- data/docs/FlowsApi.md +3 -3
- data/docs/GeneralDataProtectionRegulationApi.md +12 -12
- data/docs/GeolocationApi.md +12 -12
- data/docs/GreetingsApi.md +48 -48
- data/docs/GroupsApi.md +42 -42
- data/docs/IdentityProviderApi.md +84 -84
- data/docs/IntegrationsApi.md +123 -123
- data/docs/LanguagesApi.md +30 -30
- data/docs/LicenseApi.md +24 -24
- data/docs/LocationsApi.md +21 -21
- data/docs/MessagingApi.md +42 -42
- data/docs/MobileDevicesApi.md +15 -15
- data/docs/NotificationsApi.md +21 -21
- data/docs/OAuthApi.md +18 -18
- data/docs/ObjectsApi.md +24 -24
- data/docs/OrganizationApi.md +18 -18
- data/docs/OrganizationAuthorizationApi.md +69 -69
- data/docs/OutboundApi.md +288 -288
- data/docs/PresenceApi.md +27 -27
- data/docs/QualityApi.md +174 -174
- data/docs/QueueUserEventTopicQueueMember.md +4 -3
- data/docs/RecordingApi.md +111 -111
- data/docs/ResponseManagementApi.md +33 -33
- data/docs/RoutingApi.md +189 -189
- data/docs/ScriptsApi.md +33 -33
- data/docs/SearchApi.md +48 -48
- data/docs/StationsApi.md +15 -15
- data/docs/SuggestApi.md +12 -12
- data/docs/TelephonyProvidersEdgeApi.md +375 -375
- data/docs/TokensApi.md +6 -6
- data/docs/UserRecordingsApi.md +18 -18
- data/docs/UsersApi.md +183 -183
- data/docs/UtilitiesApi.md +12 -12
- data/docs/VoicemailApi.md +72 -72
- data/docs/WebChatApi.md +24 -24
- data/docs/WorkforceManagementApi.md +192 -192
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +50 -25
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -2
data/docs/ArchitectApi.md
CHANGED
@@ -93,7 +93,7 @@ Method | Description
|
|
93
93
|
|
94
94
|
<a name="delete_architect_emergencygroup"></a>
|
95
95
|
|
96
|
-
##
|
96
|
+
## delete_architect_emergencygroup(emergency_group_id)
|
97
97
|
|
98
98
|
|
99
99
|
|
@@ -109,7 +109,7 @@ Requires ANY permissions:
|
|
109
109
|
|
110
110
|
|
111
111
|
### Example
|
112
|
-
|
112
|
+
```{"language":"ruby"}
|
113
113
|
# load the gem
|
114
114
|
require 'purecloudplatformclientv2'
|
115
115
|
# setup authorization
|
@@ -134,7 +134,7 @@ begin
|
|
134
134
|
rescue PureCloud::ApiError => e
|
135
135
|
puts "Exception when calling ArchitectApi->delete_architect_emergencygroup: #{e}"
|
136
136
|
end
|
137
|
-
|
137
|
+
```
|
138
138
|
|
139
139
|
### Parameters
|
140
140
|
|
@@ -157,7 +157,7 @@ nil (empty response body)
|
|
157
157
|
|
158
158
|
<a name="delete_architect_ivr"></a>
|
159
159
|
|
160
|
-
##
|
160
|
+
## delete_architect_ivr(ivr_id)
|
161
161
|
|
162
162
|
|
163
163
|
|
@@ -173,7 +173,7 @@ Requires ANY permissions:
|
|
173
173
|
|
174
174
|
|
175
175
|
### Example
|
176
|
-
|
176
|
+
```{"language":"ruby"}
|
177
177
|
# load the gem
|
178
178
|
require 'purecloudplatformclientv2'
|
179
179
|
# setup authorization
|
@@ -198,7 +198,7 @@ begin
|
|
198
198
|
rescue PureCloud::ApiError => e
|
199
199
|
puts "Exception when calling ArchitectApi->delete_architect_ivr: #{e}"
|
200
200
|
end
|
201
|
-
|
201
|
+
```
|
202
202
|
|
203
203
|
### Parameters
|
204
204
|
|
@@ -221,7 +221,7 @@ nil (empty response body)
|
|
221
221
|
|
222
222
|
<a name="delete_architect_prompt"></a>
|
223
223
|
|
224
|
-
##
|
224
|
+
## delete_architect_prompt(prompt_id, opts)
|
225
225
|
|
226
226
|
|
227
227
|
|
@@ -237,7 +237,7 @@ Requires ANY permissions:
|
|
237
237
|
|
238
238
|
|
239
239
|
### Example
|
240
|
-
|
240
|
+
```{"language":"ruby"}
|
241
241
|
# load the gem
|
242
242
|
require 'purecloudplatformclientv2'
|
243
243
|
# setup authorization
|
@@ -265,7 +265,7 @@ begin
|
|
265
265
|
rescue PureCloud::ApiError => e
|
266
266
|
puts "Exception when calling ArchitectApi->delete_architect_prompt: #{e}"
|
267
267
|
end
|
268
|
-
|
268
|
+
```
|
269
269
|
|
270
270
|
### Parameters
|
271
271
|
|
@@ -289,7 +289,7 @@ nil (empty response body)
|
|
289
289
|
|
290
290
|
<a name="delete_architect_prompt_resource"></a>
|
291
291
|
|
292
|
-
##
|
292
|
+
## delete_architect_prompt_resource(prompt_id, language_code)
|
293
293
|
|
294
294
|
|
295
295
|
|
@@ -305,7 +305,7 @@ Requires ANY permissions:
|
|
305
305
|
|
306
306
|
|
307
307
|
### Example
|
308
|
-
|
308
|
+
```{"language":"ruby"}
|
309
309
|
# load the gem
|
310
310
|
require 'purecloudplatformclientv2'
|
311
311
|
# setup authorization
|
@@ -332,7 +332,7 @@ begin
|
|
332
332
|
rescue PureCloud::ApiError => e
|
333
333
|
puts "Exception when calling ArchitectApi->delete_architect_prompt_resource: #{e}"
|
334
334
|
end
|
335
|
-
|
335
|
+
```
|
336
336
|
|
337
337
|
### Parameters
|
338
338
|
|
@@ -356,7 +356,7 @@ nil (empty response body)
|
|
356
356
|
|
357
357
|
<a name="delete_architect_prompts"></a>
|
358
358
|
|
359
|
-
##
|
359
|
+
## [**Operation**](Operation.html) delete_architect_prompts(id)
|
360
360
|
|
361
361
|
|
362
362
|
|
@@ -372,7 +372,7 @@ Requires ANY permissions:
|
|
372
372
|
|
373
373
|
|
374
374
|
### Example
|
375
|
-
|
375
|
+
```{"language":"ruby"}
|
376
376
|
# load the gem
|
377
377
|
require 'purecloudplatformclientv2'
|
378
378
|
# setup authorization
|
@@ -398,7 +398,7 @@ begin
|
|
398
398
|
rescue PureCloud::ApiError => e
|
399
399
|
puts "Exception when calling ArchitectApi->delete_architect_prompts: #{e}"
|
400
400
|
end
|
401
|
-
|
401
|
+
```
|
402
402
|
|
403
403
|
### Parameters
|
404
404
|
|
@@ -421,7 +421,7 @@ Name | Type | Description | Notes
|
|
421
421
|
|
422
422
|
<a name="delete_architect_schedule"></a>
|
423
423
|
|
424
|
-
##
|
424
|
+
## delete_architect_schedule(schedule_id)
|
425
425
|
|
426
426
|
|
427
427
|
|
@@ -437,7 +437,7 @@ Requires ANY permissions:
|
|
437
437
|
|
438
438
|
|
439
439
|
### Example
|
440
|
-
|
440
|
+
```{"language":"ruby"}
|
441
441
|
# load the gem
|
442
442
|
require 'purecloudplatformclientv2'
|
443
443
|
# setup authorization
|
@@ -462,7 +462,7 @@ begin
|
|
462
462
|
rescue PureCloud::ApiError => e
|
463
463
|
puts "Exception when calling ArchitectApi->delete_architect_schedule: #{e}"
|
464
464
|
end
|
465
|
-
|
465
|
+
```
|
466
466
|
|
467
467
|
### Parameters
|
468
468
|
|
@@ -485,7 +485,7 @@ nil (empty response body)
|
|
485
485
|
|
486
486
|
<a name="delete_architect_schedulegroup"></a>
|
487
487
|
|
488
|
-
##
|
488
|
+
## delete_architect_schedulegroup(schedule_group_id)
|
489
489
|
|
490
490
|
|
491
491
|
|
@@ -501,7 +501,7 @@ Requires ANY permissions:
|
|
501
501
|
|
502
502
|
|
503
503
|
### Example
|
504
|
-
|
504
|
+
```{"language":"ruby"}
|
505
505
|
# load the gem
|
506
506
|
require 'purecloudplatformclientv2'
|
507
507
|
# setup authorization
|
@@ -526,7 +526,7 @@ begin
|
|
526
526
|
rescue PureCloud::ApiError => e
|
527
527
|
puts "Exception when calling ArchitectApi->delete_architect_schedulegroup: #{e}"
|
528
528
|
end
|
529
|
-
|
529
|
+
```
|
530
530
|
|
531
531
|
### Parameters
|
532
532
|
|
@@ -549,7 +549,7 @@ nil (empty response body)
|
|
549
549
|
|
550
550
|
<a name="delete_architect_systemprompt_resource"></a>
|
551
551
|
|
552
|
-
##
|
552
|
+
## delete_architect_systemprompt_resource(prompt_id, language_code)
|
553
553
|
|
554
554
|
|
555
555
|
|
@@ -565,7 +565,7 @@ Requires ANY permissions:
|
|
565
565
|
|
566
566
|
|
567
567
|
### Example
|
568
|
-
|
568
|
+
```{"language":"ruby"}
|
569
569
|
# load the gem
|
570
570
|
require 'purecloudplatformclientv2'
|
571
571
|
# setup authorization
|
@@ -592,7 +592,7 @@ begin
|
|
592
592
|
rescue PureCloud::ApiError => e
|
593
593
|
puts "Exception when calling ArchitectApi->delete_architect_systemprompt_resource: #{e}"
|
594
594
|
end
|
595
|
-
|
595
|
+
```
|
596
596
|
|
597
597
|
### Parameters
|
598
598
|
|
@@ -616,7 +616,7 @@ nil (empty response body)
|
|
616
616
|
|
617
617
|
<a name="delete_flow"></a>
|
618
618
|
|
619
|
-
##
|
619
|
+
## delete_flow(flow_id)
|
620
620
|
|
621
621
|
|
622
622
|
|
@@ -632,7 +632,7 @@ Requires ANY permissions:
|
|
632
632
|
|
633
633
|
|
634
634
|
### Example
|
635
|
-
|
635
|
+
```{"language":"ruby"}
|
636
636
|
# load the gem
|
637
637
|
require 'purecloudplatformclientv2'
|
638
638
|
# setup authorization
|
@@ -657,7 +657,7 @@ begin
|
|
657
657
|
rescue PureCloud::ApiError => e
|
658
658
|
puts "Exception when calling ArchitectApi->delete_flow: #{e}"
|
659
659
|
end
|
660
|
-
|
660
|
+
```
|
661
661
|
|
662
662
|
### Parameters
|
663
663
|
|
@@ -680,7 +680,7 @@ nil (empty response body)
|
|
680
680
|
|
681
681
|
<a name="delete_flows"></a>
|
682
682
|
|
683
|
-
##
|
683
|
+
## [**Operation**](Operation.html) delete_flows(id)
|
684
684
|
|
685
685
|
|
686
686
|
|
@@ -696,7 +696,7 @@ Requires ANY permissions:
|
|
696
696
|
|
697
697
|
|
698
698
|
### Example
|
699
|
-
|
699
|
+
```{"language":"ruby"}
|
700
700
|
# load the gem
|
701
701
|
require 'purecloudplatformclientv2'
|
702
702
|
# setup authorization
|
@@ -722,7 +722,7 @@ begin
|
|
722
722
|
rescue PureCloud::ApiError => e
|
723
723
|
puts "Exception when calling ArchitectApi->delete_flows: #{e}"
|
724
724
|
end
|
725
|
-
|
725
|
+
```
|
726
726
|
|
727
727
|
### Parameters
|
728
728
|
|
@@ -745,7 +745,7 @@ Name | Type | Description | Notes
|
|
745
745
|
|
746
746
|
<a name="delete_flows_datatable"></a>
|
747
747
|
|
748
|
-
##
|
748
|
+
## delete_flows_datatable(datatable_id, opts)
|
749
749
|
|
750
750
|
|
751
751
|
|
@@ -761,7 +761,7 @@ Requires ANY permissions:
|
|
761
761
|
|
762
762
|
|
763
763
|
### Example
|
764
|
-
|
764
|
+
```{"language":"ruby"}
|
765
765
|
# load the gem
|
766
766
|
require 'purecloudplatformclientv2'
|
767
767
|
# setup authorization
|
@@ -789,7 +789,7 @@ begin
|
|
789
789
|
rescue PureCloud::ApiError => e
|
790
790
|
puts "Exception when calling ArchitectApi->delete_flows_datatable: #{e}"
|
791
791
|
end
|
792
|
-
|
792
|
+
```
|
793
793
|
|
794
794
|
### Parameters
|
795
795
|
|
@@ -813,7 +813,7 @@ nil (empty response body)
|
|
813
813
|
|
814
814
|
<a name="delete_flows_datatable_row"></a>
|
815
815
|
|
816
|
-
##
|
816
|
+
## delete_flows_datatable_row(datatable_id, row_id)
|
817
817
|
|
818
818
|
|
819
819
|
|
@@ -829,7 +829,7 @@ Requires ANY permissions:
|
|
829
829
|
|
830
830
|
|
831
831
|
### Example
|
832
|
-
|
832
|
+
```{"language":"ruby"}
|
833
833
|
# load the gem
|
834
834
|
require 'purecloudplatformclientv2'
|
835
835
|
# setup authorization
|
@@ -856,7 +856,7 @@ begin
|
|
856
856
|
rescue PureCloud::ApiError => e
|
857
857
|
puts "Exception when calling ArchitectApi->delete_flows_datatable_row: #{e}"
|
858
858
|
end
|
859
|
-
|
859
|
+
```
|
860
860
|
|
861
861
|
### Parameters
|
862
862
|
|
@@ -880,7 +880,7 @@ nil (empty response body)
|
|
880
880
|
|
881
881
|
<a name="get_architect_dependencytracking"></a>
|
882
882
|
|
883
|
-
##
|
883
|
+
## [**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking(name, opts)
|
884
884
|
|
885
885
|
|
886
886
|
|
@@ -896,7 +896,7 @@ Requires ANY permissions:
|
|
896
896
|
|
897
897
|
|
898
898
|
### Example
|
899
|
-
|
899
|
+
```{"language":"ruby"}
|
900
900
|
# load the gem
|
901
901
|
require 'purecloudplatformclientv2'
|
902
902
|
# setup authorization
|
@@ -931,7 +931,7 @@ begin
|
|
931
931
|
rescue PureCloud::ApiError => e
|
932
932
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking: #{e}"
|
933
933
|
end
|
934
|
-
|
934
|
+
```
|
935
935
|
|
936
936
|
### Parameters
|
937
937
|
|
@@ -961,7 +961,7 @@ Name | Type | Description | Notes
|
|
961
961
|
|
962
962
|
<a name="get_architect_dependencytracking_build"></a>
|
963
963
|
|
964
|
-
##
|
964
|
+
## [**DependencyStatus**](DependencyStatus.html) get_architect_dependencytracking_build
|
965
965
|
|
966
966
|
|
967
967
|
|
@@ -977,7 +977,7 @@ Requires ANY permissions:
|
|
977
977
|
|
978
978
|
|
979
979
|
### Example
|
980
|
-
|
980
|
+
```{"language":"ruby"}
|
981
981
|
# load the gem
|
982
982
|
require 'purecloudplatformclientv2'
|
983
983
|
# setup authorization
|
@@ -1000,7 +1000,7 @@ begin
|
|
1000
1000
|
rescue PureCloud::ApiError => e
|
1001
1001
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_build: #{e}"
|
1002
1002
|
end
|
1003
|
-
|
1003
|
+
```
|
1004
1004
|
|
1005
1005
|
### Parameters
|
1006
1006
|
This endpoint does not need any parameter.
|
@@ -1020,7 +1020,7 @@ This endpoint does not need any parameter.
|
|
1020
1020
|
|
1021
1021
|
<a name="get_architect_dependencytracking_consumedresources"></a>
|
1022
1022
|
|
1023
|
-
##
|
1023
|
+
## [**ConsumedResourcesEntityListing**](ConsumedResourcesEntityListing.html) get_architect_dependencytracking_consumedresources(id, version, object_type, opts)
|
1024
1024
|
|
1025
1025
|
|
1026
1026
|
|
@@ -1036,7 +1036,7 @@ Requires ANY permissions:
|
|
1036
1036
|
|
1037
1037
|
|
1038
1038
|
### Example
|
1039
|
-
|
1039
|
+
```{"language":"ruby"}
|
1040
1040
|
# load the gem
|
1041
1041
|
require 'purecloudplatformclientv2'
|
1042
1042
|
# setup authorization
|
@@ -1069,7 +1069,7 @@ begin
|
|
1069
1069
|
rescue PureCloud::ApiError => e
|
1070
1070
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_consumedresources: #{e}"
|
1071
1071
|
end
|
1072
|
-
|
1072
|
+
```
|
1073
1073
|
|
1074
1074
|
### Parameters
|
1075
1075
|
|
@@ -1095,7 +1095,7 @@ Name | Type | Description | Notes
|
|
1095
1095
|
|
1096
1096
|
<a name="get_architect_dependencytracking_consumingresources"></a>
|
1097
1097
|
|
1098
|
-
##
|
1098
|
+
## [**ConsumingResourcesEntityListing**](ConsumingResourcesEntityListing.html) get_architect_dependencytracking_consumingresources(id, object_type, opts)
|
1099
1099
|
|
1100
1100
|
|
1101
1101
|
|
@@ -1111,7 +1111,7 @@ Requires ANY permissions:
|
|
1111
1111
|
|
1112
1112
|
|
1113
1113
|
### Example
|
1114
|
-
|
1114
|
+
```{"language":"ruby"}
|
1115
1115
|
# load the gem
|
1116
1116
|
require 'purecloudplatformclientv2'
|
1117
1117
|
# setup authorization
|
@@ -1142,7 +1142,7 @@ begin
|
|
1142
1142
|
rescue PureCloud::ApiError => e
|
1143
1143
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_consumingresources: #{e}"
|
1144
1144
|
end
|
1145
|
-
|
1145
|
+
```
|
1146
1146
|
|
1147
1147
|
### Parameters
|
1148
1148
|
|
@@ -1167,7 +1167,7 @@ Name | Type | Description | Notes
|
|
1167
1167
|
|
1168
1168
|
<a name="get_architect_dependencytracking_deletedresourceconsumers"></a>
|
1169
1169
|
|
1170
|
-
##
|
1170
|
+
## [**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_deletedresourceconsumers(opts)
|
1171
1171
|
|
1172
1172
|
|
1173
1173
|
|
@@ -1183,7 +1183,7 @@ Requires ANY permissions:
|
|
1183
1183
|
|
1184
1184
|
|
1185
1185
|
### Example
|
1186
|
-
|
1186
|
+
```{"language":"ruby"}
|
1187
1187
|
# load the gem
|
1188
1188
|
require 'purecloudplatformclientv2'
|
1189
1189
|
# setup authorization
|
@@ -1216,7 +1216,7 @@ begin
|
|
1216
1216
|
rescue PureCloud::ApiError => e
|
1217
1217
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_deletedresourceconsumers: #{e}"
|
1218
1218
|
end
|
1219
|
-
|
1219
|
+
```
|
1220
1220
|
|
1221
1221
|
### Parameters
|
1222
1222
|
|
@@ -1245,7 +1245,7 @@ Name | Type | Description | Notes
|
|
1245
1245
|
|
1246
1246
|
<a name="get_architect_dependencytracking_object"></a>
|
1247
1247
|
|
1248
|
-
##
|
1248
|
+
## [**DependencyObject**](DependencyObject.html) get_architect_dependencytracking_object(id, opts)
|
1249
1249
|
|
1250
1250
|
|
1251
1251
|
|
@@ -1261,7 +1261,7 @@ Requires ANY permissions:
|
|
1261
1261
|
|
1262
1262
|
|
1263
1263
|
### Example
|
1264
|
-
|
1264
|
+
```{"language":"ruby"}
|
1265
1265
|
# load the gem
|
1266
1266
|
require 'purecloudplatformclientv2'
|
1267
1267
|
# setup authorization
|
@@ -1295,7 +1295,7 @@ begin
|
|
1295
1295
|
rescue PureCloud::ApiError => e
|
1296
1296
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_object: #{e}"
|
1297
1297
|
end
|
1298
|
-
|
1298
|
+
```
|
1299
1299
|
|
1300
1300
|
### Parameters
|
1301
1301
|
|
@@ -1324,7 +1324,7 @@ Name | Type | Description | Notes
|
|
1324
1324
|
|
1325
1325
|
<a name="get_architect_dependencytracking_type"></a>
|
1326
1326
|
|
1327
|
-
##
|
1327
|
+
## [**DependencyType**](DependencyType.html) get_architect_dependencytracking_type(type_id)
|
1328
1328
|
|
1329
1329
|
|
1330
1330
|
|
@@ -1340,7 +1340,7 @@ Requires ANY permissions:
|
|
1340
1340
|
|
1341
1341
|
|
1342
1342
|
### Example
|
1343
|
-
|
1343
|
+
```{"language":"ruby"}
|
1344
1344
|
# load the gem
|
1345
1345
|
require 'purecloudplatformclientv2'
|
1346
1346
|
# setup authorization
|
@@ -1366,7 +1366,7 @@ begin
|
|
1366
1366
|
rescue PureCloud::ApiError => e
|
1367
1367
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_type: #{e}"
|
1368
1368
|
end
|
1369
|
-
|
1369
|
+
```
|
1370
1370
|
|
1371
1371
|
### Parameters
|
1372
1372
|
|
@@ -1389,7 +1389,7 @@ Name | Type | Description | Notes
|
|
1389
1389
|
|
1390
1390
|
<a name="get_architect_dependencytracking_types"></a>
|
1391
1391
|
|
1392
|
-
##
|
1392
|
+
## [**DependencyTypeEntityListing**](DependencyTypeEntityListing.html) get_architect_dependencytracking_types(opts)
|
1393
1393
|
|
1394
1394
|
|
1395
1395
|
|
@@ -1405,7 +1405,7 @@ Requires ANY permissions:
|
|
1405
1405
|
|
1406
1406
|
|
1407
1407
|
### Example
|
1408
|
-
|
1408
|
+
```{"language":"ruby"}
|
1409
1409
|
# load the gem
|
1410
1410
|
require 'purecloudplatformclientv2'
|
1411
1411
|
# setup authorization
|
@@ -1433,7 +1433,7 @@ begin
|
|
1433
1433
|
rescue PureCloud::ApiError => e
|
1434
1434
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_types: #{e}"
|
1435
1435
|
end
|
1436
|
-
|
1436
|
+
```
|
1437
1437
|
|
1438
1438
|
### Parameters
|
1439
1439
|
|
@@ -1457,7 +1457,7 @@ Name | Type | Description | Notes
|
|
1457
1457
|
|
1458
1458
|
<a name="get_architect_dependencytracking_updatedresourceconsumers"></a>
|
1459
1459
|
|
1460
|
-
##
|
1460
|
+
## [**DependencyObjectEntityListing**](DependencyObjectEntityListing.html) get_architect_dependencytracking_updatedresourceconsumers(opts)
|
1461
1461
|
|
1462
1462
|
|
1463
1463
|
|
@@ -1473,7 +1473,7 @@ Requires ANY permissions:
|
|
1473
1473
|
|
1474
1474
|
|
1475
1475
|
### Example
|
1476
|
-
|
1476
|
+
```{"language":"ruby"}
|
1477
1477
|
# load the gem
|
1478
1478
|
require 'purecloudplatformclientv2'
|
1479
1479
|
# setup authorization
|
@@ -1505,7 +1505,7 @@ begin
|
|
1505
1505
|
rescue PureCloud::ApiError => e
|
1506
1506
|
puts "Exception when calling ArchitectApi->get_architect_dependencytracking_updatedresourceconsumers: #{e}"
|
1507
1507
|
end
|
1508
|
-
|
1508
|
+
```
|
1509
1509
|
|
1510
1510
|
### Parameters
|
1511
1511
|
|
@@ -1533,7 +1533,7 @@ Name | Type | Description | Notes
|
|
1533
1533
|
|
1534
1534
|
<a name="get_architect_emergencygroup"></a>
|
1535
1535
|
|
1536
|
-
##
|
1536
|
+
## [**EmergencyGroup**](EmergencyGroup.html) get_architect_emergencygroup(emergency_group_id)
|
1537
1537
|
|
1538
1538
|
|
1539
1539
|
|
@@ -1549,7 +1549,7 @@ Requires ANY permissions:
|
|
1549
1549
|
|
1550
1550
|
|
1551
1551
|
### Example
|
1552
|
-
|
1552
|
+
```{"language":"ruby"}
|
1553
1553
|
# load the gem
|
1554
1554
|
require 'purecloudplatformclientv2'
|
1555
1555
|
# setup authorization
|
@@ -1575,7 +1575,7 @@ begin
|
|
1575
1575
|
rescue PureCloud::ApiError => e
|
1576
1576
|
puts "Exception when calling ArchitectApi->get_architect_emergencygroup: #{e}"
|
1577
1577
|
end
|
1578
|
-
|
1578
|
+
```
|
1579
1579
|
|
1580
1580
|
### Parameters
|
1581
1581
|
|
@@ -1598,7 +1598,7 @@ Name | Type | Description | Notes
|
|
1598
1598
|
|
1599
1599
|
<a name="get_architect_emergencygroups"></a>
|
1600
1600
|
|
1601
|
-
##
|
1601
|
+
## [**EmergencyGroupListing**](EmergencyGroupListing.html) get_architect_emergencygroups(opts)
|
1602
1602
|
|
1603
1603
|
|
1604
1604
|
|
@@ -1614,7 +1614,7 @@ Requires ANY permissions:
|
|
1614
1614
|
|
1615
1615
|
|
1616
1616
|
### Example
|
1617
|
-
|
1617
|
+
```{"language":"ruby"}
|
1618
1618
|
# load the gem
|
1619
1619
|
require 'purecloudplatformclientv2'
|
1620
1620
|
# setup authorization
|
@@ -1645,7 +1645,7 @@ begin
|
|
1645
1645
|
rescue PureCloud::ApiError => e
|
1646
1646
|
puts "Exception when calling ArchitectApi->get_architect_emergencygroups: #{e}"
|
1647
1647
|
end
|
1648
|
-
|
1648
|
+
```
|
1649
1649
|
|
1650
1650
|
### Parameters
|
1651
1651
|
|
@@ -1672,7 +1672,7 @@ Name | Type | Description | Notes
|
|
1672
1672
|
|
1673
1673
|
<a name="get_architect_ivr"></a>
|
1674
1674
|
|
1675
|
-
##
|
1675
|
+
## [**IVR**](IVR.html) get_architect_ivr(ivr_id)
|
1676
1676
|
|
1677
1677
|
|
1678
1678
|
|
@@ -1688,7 +1688,7 @@ Requires ANY permissions:
|
|
1688
1688
|
|
1689
1689
|
|
1690
1690
|
### Example
|
1691
|
-
|
1691
|
+
```{"language":"ruby"}
|
1692
1692
|
# load the gem
|
1693
1693
|
require 'purecloudplatformclientv2'
|
1694
1694
|
# setup authorization
|
@@ -1714,7 +1714,7 @@ begin
|
|
1714
1714
|
rescue PureCloud::ApiError => e
|
1715
1715
|
puts "Exception when calling ArchitectApi->get_architect_ivr: #{e}"
|
1716
1716
|
end
|
1717
|
-
|
1717
|
+
```
|
1718
1718
|
|
1719
1719
|
### Parameters
|
1720
1720
|
|
@@ -1737,7 +1737,7 @@ Name | Type | Description | Notes
|
|
1737
1737
|
|
1738
1738
|
<a name="get_architect_ivrs"></a>
|
1739
1739
|
|
1740
|
-
##
|
1740
|
+
## [**IVREntityListing**](IVREntityListing.html) get_architect_ivrs(opts)
|
1741
1741
|
|
1742
1742
|
|
1743
1743
|
|
@@ -1753,7 +1753,7 @@ Requires ANY permissions:
|
|
1753
1753
|
|
1754
1754
|
|
1755
1755
|
### Example
|
1756
|
-
|
1756
|
+
```{"language":"ruby"}
|
1757
1757
|
# load the gem
|
1758
1758
|
require 'purecloudplatformclientv2'
|
1759
1759
|
# setup authorization
|
@@ -1784,7 +1784,7 @@ begin
|
|
1784
1784
|
rescue PureCloud::ApiError => e
|
1785
1785
|
puts "Exception when calling ArchitectApi->get_architect_ivrs: #{e}"
|
1786
1786
|
end
|
1787
|
-
|
1787
|
+
```
|
1788
1788
|
|
1789
1789
|
### Parameters
|
1790
1790
|
|
@@ -1811,7 +1811,7 @@ Name | Type | Description | Notes
|
|
1811
1811
|
|
1812
1812
|
<a name="get_architect_prompt"></a>
|
1813
1813
|
|
1814
|
-
##
|
1814
|
+
## [**Prompt**](Prompt.html) get_architect_prompt(prompt_id)
|
1815
1815
|
|
1816
1816
|
|
1817
1817
|
|
@@ -1827,7 +1827,7 @@ Requires ANY permissions:
|
|
1827
1827
|
|
1828
1828
|
|
1829
1829
|
### Example
|
1830
|
-
|
1830
|
+
```{"language":"ruby"}
|
1831
1831
|
# load the gem
|
1832
1832
|
require 'purecloudplatformclientv2'
|
1833
1833
|
# setup authorization
|
@@ -1853,7 +1853,7 @@ begin
|
|
1853
1853
|
rescue PureCloud::ApiError => e
|
1854
1854
|
puts "Exception when calling ArchitectApi->get_architect_prompt: #{e}"
|
1855
1855
|
end
|
1856
|
-
|
1856
|
+
```
|
1857
1857
|
|
1858
1858
|
### Parameters
|
1859
1859
|
|
@@ -1876,7 +1876,7 @@ Name | Type | Description | Notes
|
|
1876
1876
|
|
1877
1877
|
<a name="get_architect_prompt_history_history_id"></a>
|
1878
1878
|
|
1879
|
-
##
|
1879
|
+
## [**HistoryListing**](HistoryListing.html) get_architect_prompt_history_history_id(prompt_id, history_id, opts)
|
1880
1880
|
|
1881
1881
|
|
1882
1882
|
|
@@ -1892,7 +1892,7 @@ Requires ANY permissions:
|
|
1892
1892
|
|
1893
1893
|
|
1894
1894
|
### Example
|
1895
|
-
|
1895
|
+
```{"language":"ruby"}
|
1896
1896
|
# load the gem
|
1897
1897
|
require 'purecloudplatformclientv2'
|
1898
1898
|
# setup authorization
|
@@ -1927,7 +1927,7 @@ begin
|
|
1927
1927
|
rescue PureCloud::ApiError => e
|
1928
1928
|
puts "Exception when calling ArchitectApi->get_architect_prompt_history_history_id: #{e}"
|
1929
1929
|
end
|
1930
|
-
|
1930
|
+
```
|
1931
1931
|
|
1932
1932
|
### Parameters
|
1933
1933
|
|
@@ -1956,7 +1956,7 @@ Name | Type | Description | Notes
|
|
1956
1956
|
|
1957
1957
|
<a name="get_architect_prompt_resource"></a>
|
1958
1958
|
|
1959
|
-
##
|
1959
|
+
## [**PromptAsset**](PromptAsset.html) get_architect_prompt_resource(prompt_id, language_code)
|
1960
1960
|
|
1961
1961
|
|
1962
1962
|
|
@@ -1972,7 +1972,7 @@ Requires ANY permissions:
|
|
1972
1972
|
|
1973
1973
|
|
1974
1974
|
### Example
|
1975
|
-
|
1975
|
+
```{"language":"ruby"}
|
1976
1976
|
# load the gem
|
1977
1977
|
require 'purecloudplatformclientv2'
|
1978
1978
|
# setup authorization
|
@@ -2000,7 +2000,7 @@ begin
|
|
2000
2000
|
rescue PureCloud::ApiError => e
|
2001
2001
|
puts "Exception when calling ArchitectApi->get_architect_prompt_resource: #{e}"
|
2002
2002
|
end
|
2003
|
-
|
2003
|
+
```
|
2004
2004
|
|
2005
2005
|
### Parameters
|
2006
2006
|
|
@@ -2024,7 +2024,7 @@ Name | Type | Description | Notes
|
|
2024
2024
|
|
2025
2025
|
<a name="get_architect_prompt_resources"></a>
|
2026
2026
|
|
2027
|
-
##
|
2027
|
+
## [**PromptAssetEntityListing**](PromptAssetEntityListing.html) get_architect_prompt_resources(prompt_id, opts)
|
2028
2028
|
|
2029
2029
|
|
2030
2030
|
|
@@ -2040,7 +2040,7 @@ Requires ANY permissions:
|
|
2040
2040
|
|
2041
2041
|
|
2042
2042
|
### Example
|
2043
|
-
|
2043
|
+
```{"language":"ruby"}
|
2044
2044
|
# load the gem
|
2045
2045
|
require 'purecloudplatformclientv2'
|
2046
2046
|
# setup authorization
|
@@ -2070,7 +2070,7 @@ begin
|
|
2070
2070
|
rescue PureCloud::ApiError => e
|
2071
2071
|
puts "Exception when calling ArchitectApi->get_architect_prompt_resources: #{e}"
|
2072
2072
|
end
|
2073
|
-
|
2073
|
+
```
|
2074
2074
|
|
2075
2075
|
### Parameters
|
2076
2076
|
|
@@ -2095,7 +2095,7 @@ Name | Type | Description | Notes
|
|
2095
2095
|
|
2096
2096
|
<a name="get_architect_prompts"></a>
|
2097
2097
|
|
2098
|
-
##
|
2098
|
+
## [**PromptEntityListing**](PromptEntityListing.html) get_architect_prompts(opts)
|
2099
2099
|
|
2100
2100
|
|
2101
2101
|
|
@@ -2111,7 +2111,7 @@ Requires ANY permissions:
|
|
2111
2111
|
|
2112
2112
|
|
2113
2113
|
### Example
|
2114
|
-
|
2114
|
+
```{"language":"ruby"}
|
2115
2115
|
# load the gem
|
2116
2116
|
require 'purecloudplatformclientv2'
|
2117
2117
|
# setup authorization
|
@@ -2144,7 +2144,7 @@ begin
|
|
2144
2144
|
rescue PureCloud::ApiError => e
|
2145
2145
|
puts "Exception when calling ArchitectApi->get_architect_prompts: #{e}"
|
2146
2146
|
end
|
2147
|
-
|
2147
|
+
```
|
2148
2148
|
|
2149
2149
|
### Parameters
|
2150
2150
|
|
@@ -2173,7 +2173,7 @@ Name | Type | Description | Notes
|
|
2173
2173
|
|
2174
2174
|
<a name="get_architect_schedule"></a>
|
2175
2175
|
|
2176
|
-
##
|
2176
|
+
## [**Schedule**](Schedule.html) get_architect_schedule(schedule_id)
|
2177
2177
|
|
2178
2178
|
|
2179
2179
|
|
@@ -2189,7 +2189,7 @@ Requires ANY permissions:
|
|
2189
2189
|
|
2190
2190
|
|
2191
2191
|
### Example
|
2192
|
-
|
2192
|
+
```{"language":"ruby"}
|
2193
2193
|
# load the gem
|
2194
2194
|
require 'purecloudplatformclientv2'
|
2195
2195
|
# setup authorization
|
@@ -2215,7 +2215,7 @@ begin
|
|
2215
2215
|
rescue PureCloud::ApiError => e
|
2216
2216
|
puts "Exception when calling ArchitectApi->get_architect_schedule: #{e}"
|
2217
2217
|
end
|
2218
|
-
|
2218
|
+
```
|
2219
2219
|
|
2220
2220
|
### Parameters
|
2221
2221
|
|
@@ -2238,7 +2238,7 @@ Name | Type | Description | Notes
|
|
2238
2238
|
|
2239
2239
|
<a name="get_architect_schedulegroup"></a>
|
2240
2240
|
|
2241
|
-
##
|
2241
|
+
## [**ScheduleGroup**](ScheduleGroup.html) get_architect_schedulegroup(schedule_group_id)
|
2242
2242
|
|
2243
2243
|
|
2244
2244
|
|
@@ -2254,7 +2254,7 @@ Requires ANY permissions:
|
|
2254
2254
|
|
2255
2255
|
|
2256
2256
|
### Example
|
2257
|
-
|
2257
|
+
```{"language":"ruby"}
|
2258
2258
|
# load the gem
|
2259
2259
|
require 'purecloudplatformclientv2'
|
2260
2260
|
# setup authorization
|
@@ -2280,7 +2280,7 @@ begin
|
|
2280
2280
|
rescue PureCloud::ApiError => e
|
2281
2281
|
puts "Exception when calling ArchitectApi->get_architect_schedulegroup: #{e}"
|
2282
2282
|
end
|
2283
|
-
|
2283
|
+
```
|
2284
2284
|
|
2285
2285
|
### Parameters
|
2286
2286
|
|
@@ -2303,7 +2303,7 @@ Name | Type | Description | Notes
|
|
2303
2303
|
|
2304
2304
|
<a name="get_architect_schedulegroups"></a>
|
2305
2305
|
|
2306
|
-
##
|
2306
|
+
## [**ScheduleGroupEntityListing**](ScheduleGroupEntityListing.html) get_architect_schedulegroups(opts)
|
2307
2307
|
|
2308
2308
|
|
2309
2309
|
|
@@ -2319,7 +2319,7 @@ Requires ANY permissions:
|
|
2319
2319
|
|
2320
2320
|
|
2321
2321
|
### Example
|
2322
|
-
|
2322
|
+
```{"language":"ruby"}
|
2323
2323
|
# load the gem
|
2324
2324
|
require 'purecloudplatformclientv2'
|
2325
2325
|
# setup authorization
|
@@ -2350,7 +2350,7 @@ begin
|
|
2350
2350
|
rescue PureCloud::ApiError => e
|
2351
2351
|
puts "Exception when calling ArchitectApi->get_architect_schedulegroups: #{e}"
|
2352
2352
|
end
|
2353
|
-
|
2353
|
+
```
|
2354
2354
|
|
2355
2355
|
### Parameters
|
2356
2356
|
|
@@ -2377,7 +2377,7 @@ Name | Type | Description | Notes
|
|
2377
2377
|
|
2378
2378
|
<a name="get_architect_schedules"></a>
|
2379
2379
|
|
2380
|
-
##
|
2380
|
+
## [**ScheduleEntityListing**](ScheduleEntityListing.html) get_architect_schedules(opts)
|
2381
2381
|
|
2382
2382
|
|
2383
2383
|
|
@@ -2393,7 +2393,7 @@ Requires ANY permissions:
|
|
2393
2393
|
|
2394
2394
|
|
2395
2395
|
### Example
|
2396
|
-
|
2396
|
+
```{"language":"ruby"}
|
2397
2397
|
# load the gem
|
2398
2398
|
require 'purecloudplatformclientv2'
|
2399
2399
|
# setup authorization
|
@@ -2424,7 +2424,7 @@ begin
|
|
2424
2424
|
rescue PureCloud::ApiError => e
|
2425
2425
|
puts "Exception when calling ArchitectApi->get_architect_schedules: #{e}"
|
2426
2426
|
end
|
2427
|
-
|
2427
|
+
```
|
2428
2428
|
|
2429
2429
|
### Parameters
|
2430
2430
|
|
@@ -2451,7 +2451,7 @@ Name | Type | Description | Notes
|
|
2451
2451
|
|
2452
2452
|
<a name="get_architect_systemprompt"></a>
|
2453
2453
|
|
2454
|
-
##
|
2454
|
+
## [**SystemPrompt**](SystemPrompt.html) get_architect_systemprompt(prompt_id)
|
2455
2455
|
|
2456
2456
|
|
2457
2457
|
|
@@ -2467,7 +2467,7 @@ Requires ANY permissions:
|
|
2467
2467
|
|
2468
2468
|
|
2469
2469
|
### Example
|
2470
|
-
|
2470
|
+
```{"language":"ruby"}
|
2471
2471
|
# load the gem
|
2472
2472
|
require 'purecloudplatformclientv2'
|
2473
2473
|
# setup authorization
|
@@ -2493,7 +2493,7 @@ begin
|
|
2493
2493
|
rescue PureCloud::ApiError => e
|
2494
2494
|
puts "Exception when calling ArchitectApi->get_architect_systemprompt: #{e}"
|
2495
2495
|
end
|
2496
|
-
|
2496
|
+
```
|
2497
2497
|
|
2498
2498
|
### Parameters
|
2499
2499
|
|
@@ -2516,7 +2516,7 @@ Name | Type | Description | Notes
|
|
2516
2516
|
|
2517
2517
|
<a name="get_architect_systemprompt_history_history_id"></a>
|
2518
2518
|
|
2519
|
-
##
|
2519
|
+
## [**HistoryListing**](HistoryListing.html) get_architect_systemprompt_history_history_id(prompt_id, history_id, opts)
|
2520
2520
|
|
2521
2521
|
|
2522
2522
|
|
@@ -2532,7 +2532,7 @@ Requires ANY permissions:
|
|
2532
2532
|
|
2533
2533
|
|
2534
2534
|
### Example
|
2535
|
-
|
2535
|
+
```{"language":"ruby"}
|
2536
2536
|
# load the gem
|
2537
2537
|
require 'purecloudplatformclientv2'
|
2538
2538
|
# setup authorization
|
@@ -2567,7 +2567,7 @@ begin
|
|
2567
2567
|
rescue PureCloud::ApiError => e
|
2568
2568
|
puts "Exception when calling ArchitectApi->get_architect_systemprompt_history_history_id: #{e}"
|
2569
2569
|
end
|
2570
|
-
|
2570
|
+
```
|
2571
2571
|
|
2572
2572
|
### Parameters
|
2573
2573
|
|
@@ -2596,7 +2596,7 @@ Name | Type | Description | Notes
|
|
2596
2596
|
|
2597
2597
|
<a name="get_architect_systemprompt_resource"></a>
|
2598
2598
|
|
2599
|
-
##
|
2599
|
+
## [**SystemPromptAsset**](SystemPromptAsset.html) get_architect_systemprompt_resource(prompt_id, language_code)
|
2600
2600
|
|
2601
2601
|
|
2602
2602
|
|
@@ -2612,7 +2612,7 @@ Requires ANY permissions:
|
|
2612
2612
|
|
2613
2613
|
|
2614
2614
|
### Example
|
2615
|
-
|
2615
|
+
```{"language":"ruby"}
|
2616
2616
|
# load the gem
|
2617
2617
|
require 'purecloudplatformclientv2'
|
2618
2618
|
# setup authorization
|
@@ -2640,7 +2640,7 @@ begin
|
|
2640
2640
|
rescue PureCloud::ApiError => e
|
2641
2641
|
puts "Exception when calling ArchitectApi->get_architect_systemprompt_resource: #{e}"
|
2642
2642
|
end
|
2643
|
-
|
2643
|
+
```
|
2644
2644
|
|
2645
2645
|
### Parameters
|
2646
2646
|
|
@@ -2664,7 +2664,7 @@ Name | Type | Description | Notes
|
|
2664
2664
|
|
2665
2665
|
<a name="get_architect_systemprompt_resources"></a>
|
2666
2666
|
|
2667
|
-
##
|
2667
|
+
## [**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html) get_architect_systemprompt_resources(prompt_id, opts)
|
2668
2668
|
|
2669
2669
|
|
2670
2670
|
|
@@ -2680,7 +2680,7 @@ Requires ANY permissions:
|
|
2680
2680
|
|
2681
2681
|
|
2682
2682
|
### Example
|
2683
|
-
|
2683
|
+
```{"language":"ruby"}
|
2684
2684
|
# load the gem
|
2685
2685
|
require 'purecloudplatformclientv2'
|
2686
2686
|
# setup authorization
|
@@ -2712,7 +2712,7 @@ begin
|
|
2712
2712
|
rescue PureCloud::ApiError => e
|
2713
2713
|
puts "Exception when calling ArchitectApi->get_architect_systemprompt_resources: #{e}"
|
2714
2714
|
end
|
2715
|
-
|
2715
|
+
```
|
2716
2716
|
|
2717
2717
|
### Parameters
|
2718
2718
|
|
@@ -2739,7 +2739,7 @@ Name | Type | Description | Notes
|
|
2739
2739
|
|
2740
2740
|
<a name="get_architect_systemprompts"></a>
|
2741
2741
|
|
2742
|
-
##
|
2742
|
+
## [**SystemPromptEntityListing**](SystemPromptEntityListing.html) get_architect_systemprompts(opts)
|
2743
2743
|
|
2744
2744
|
|
2745
2745
|
|
@@ -2755,7 +2755,7 @@ Requires ANY permissions:
|
|
2755
2755
|
|
2756
2756
|
|
2757
2757
|
### Example
|
2758
|
-
|
2758
|
+
```{"language":"ruby"}
|
2759
2759
|
# load the gem
|
2760
2760
|
require 'purecloudplatformclientv2'
|
2761
2761
|
# setup authorization
|
@@ -2788,7 +2788,7 @@ begin
|
|
2788
2788
|
rescue PureCloud::ApiError => e
|
2789
2789
|
puts "Exception when calling ArchitectApi->get_architect_systemprompts: #{e}"
|
2790
2790
|
end
|
2791
|
-
|
2791
|
+
```
|
2792
2792
|
|
2793
2793
|
### Parameters
|
2794
2794
|
|
@@ -2817,7 +2817,7 @@ Name | Type | Description | Notes
|
|
2817
2817
|
|
2818
2818
|
<a name="get_flow"></a>
|
2819
2819
|
|
2820
|
-
##
|
2820
|
+
## [**Flow**](Flow.html) get_flow(flow_id, opts)
|
2821
2821
|
|
2822
2822
|
|
2823
2823
|
|
@@ -2833,7 +2833,7 @@ Requires ANY permissions:
|
|
2833
2833
|
|
2834
2834
|
|
2835
2835
|
### Example
|
2836
|
-
|
2836
|
+
```{"language":"ruby"}
|
2837
2837
|
# load the gem
|
2838
2838
|
require 'purecloudplatformclientv2'
|
2839
2839
|
# setup authorization
|
@@ -2862,7 +2862,7 @@ begin
|
|
2862
2862
|
rescue PureCloud::ApiError => e
|
2863
2863
|
puts "Exception when calling ArchitectApi->get_flow: #{e}"
|
2864
2864
|
end
|
2865
|
-
|
2865
|
+
```
|
2866
2866
|
|
2867
2867
|
### Parameters
|
2868
2868
|
|
@@ -2886,7 +2886,7 @@ Name | Type | Description | Notes
|
|
2886
2886
|
|
2887
2887
|
<a name="get_flow_history_history_id"></a>
|
2888
2888
|
|
2889
|
-
##
|
2889
|
+
## [**HistoryListing**](HistoryListing.html) get_flow_history_history_id(flow_id, history_id, opts)
|
2890
2890
|
|
2891
2891
|
|
2892
2892
|
|
@@ -2902,7 +2902,7 @@ Requires ANY permissions:
|
|
2902
2902
|
|
2903
2903
|
|
2904
2904
|
### Example
|
2905
|
-
|
2905
|
+
```{"language":"ruby"}
|
2906
2906
|
# load the gem
|
2907
2907
|
require 'purecloudplatformclientv2'
|
2908
2908
|
# setup authorization
|
@@ -2937,7 +2937,7 @@ begin
|
|
2937
2937
|
rescue PureCloud::ApiError => e
|
2938
2938
|
puts "Exception when calling ArchitectApi->get_flow_history_history_id: #{e}"
|
2939
2939
|
end
|
2940
|
-
|
2940
|
+
```
|
2941
2941
|
|
2942
2942
|
### Parameters
|
2943
2943
|
|
@@ -2966,7 +2966,7 @@ Name | Type | Description | Notes
|
|
2966
2966
|
|
2967
2967
|
<a name="get_flow_latestconfiguration"></a>
|
2968
2968
|
|
2969
|
-
##
|
2969
|
+
## Object** get_flow_latestconfiguration(flow_id, opts)
|
2970
2970
|
|
2971
2971
|
|
2972
2972
|
|
@@ -2982,7 +2982,7 @@ Requires ANY permissions:
|
|
2982
2982
|
|
2983
2983
|
|
2984
2984
|
### Example
|
2985
|
-
|
2985
|
+
```{"language":"ruby"}
|
2986
2986
|
# load the gem
|
2987
2987
|
require 'purecloudplatformclientv2'
|
2988
2988
|
# setup authorization
|
@@ -3011,7 +3011,7 @@ begin
|
|
3011
3011
|
rescue PureCloud::ApiError => e
|
3012
3012
|
puts "Exception when calling ArchitectApi->get_flow_latestconfiguration: #{e}"
|
3013
3013
|
end
|
3014
|
-
|
3014
|
+
```
|
3015
3015
|
|
3016
3016
|
### Parameters
|
3017
3017
|
|
@@ -3035,7 +3035,7 @@ Name | Type | Description | Notes
|
|
3035
3035
|
|
3036
3036
|
<a name="get_flow_version"></a>
|
3037
3037
|
|
3038
|
-
##
|
3038
|
+
## [**FlowVersion**](FlowVersion.html) get_flow_version(flow_id, version_id, opts)
|
3039
3039
|
|
3040
3040
|
|
3041
3041
|
|
@@ -3051,7 +3051,7 @@ Requires ANY permissions:
|
|
3051
3051
|
|
3052
3052
|
|
3053
3053
|
### Example
|
3054
|
-
|
3054
|
+
```{"language":"ruby"}
|
3055
3055
|
# load the gem
|
3056
3056
|
require 'purecloudplatformclientv2'
|
3057
3057
|
# setup authorization
|
@@ -3082,7 +3082,7 @@ begin
|
|
3082
3082
|
rescue PureCloud::ApiError => e
|
3083
3083
|
puts "Exception when calling ArchitectApi->get_flow_version: #{e}"
|
3084
3084
|
end
|
3085
|
-
|
3085
|
+
```
|
3086
3086
|
|
3087
3087
|
### Parameters
|
3088
3088
|
|
@@ -3107,7 +3107,7 @@ Name | Type | Description | Notes
|
|
3107
3107
|
|
3108
3108
|
<a name="get_flow_version_configuration"></a>
|
3109
3109
|
|
3110
|
-
##
|
3110
|
+
## Object** get_flow_version_configuration(flow_id, version_id, opts)
|
3111
3111
|
|
3112
3112
|
|
3113
3113
|
|
@@ -3123,7 +3123,7 @@ Requires ANY permissions:
|
|
3123
3123
|
|
3124
3124
|
|
3125
3125
|
### Example
|
3126
|
-
|
3126
|
+
```{"language":"ruby"}
|
3127
3127
|
# load the gem
|
3128
3128
|
require 'purecloudplatformclientv2'
|
3129
3129
|
# setup authorization
|
@@ -3154,7 +3154,7 @@ begin
|
|
3154
3154
|
rescue PureCloud::ApiError => e
|
3155
3155
|
puts "Exception when calling ArchitectApi->get_flow_version_configuration: #{e}"
|
3156
3156
|
end
|
3157
|
-
|
3157
|
+
```
|
3158
3158
|
|
3159
3159
|
### Parameters
|
3160
3160
|
|
@@ -3179,7 +3179,7 @@ Name | Type | Description | Notes
|
|
3179
3179
|
|
3180
3180
|
<a name="get_flow_versions"></a>
|
3181
3181
|
|
3182
|
-
##
|
3182
|
+
## [**FlowVersionEntityListing**](FlowVersionEntityListing.html) get_flow_versions(flow_id, opts)
|
3183
3183
|
|
3184
3184
|
|
3185
3185
|
|
@@ -3195,7 +3195,7 @@ Requires ANY permissions:
|
|
3195
3195
|
|
3196
3196
|
|
3197
3197
|
### Example
|
3198
|
-
|
3198
|
+
```{"language":"ruby"}
|
3199
3199
|
# load the gem
|
3200
3200
|
require 'purecloudplatformclientv2'
|
3201
3201
|
# setup authorization
|
@@ -3226,7 +3226,7 @@ begin
|
|
3226
3226
|
rescue PureCloud::ApiError => e
|
3227
3227
|
puts "Exception when calling ArchitectApi->get_flow_versions: #{e}"
|
3228
3228
|
end
|
3229
|
-
|
3229
|
+
```
|
3230
3230
|
|
3231
3231
|
### Parameters
|
3232
3232
|
|
@@ -3252,7 +3252,7 @@ Name | Type | Description | Notes
|
|
3252
3252
|
|
3253
3253
|
<a name="get_flows"></a>
|
3254
3254
|
|
3255
|
-
##
|
3255
|
+
## [**FlowEntityListing**](FlowEntityListing.html) get_flows(opts)
|
3256
3256
|
|
3257
3257
|
|
3258
3258
|
|
@@ -3268,7 +3268,7 @@ Requires ANY permissions:
|
|
3268
3268
|
|
3269
3269
|
|
3270
3270
|
### Example
|
3271
|
-
|
3271
|
+
```{"language":"ruby"}
|
3272
3272
|
# load the gem
|
3273
3273
|
require 'purecloudplatformclientv2'
|
3274
3274
|
# setup authorization
|
@@ -3312,7 +3312,7 @@ begin
|
|
3312
3312
|
rescue PureCloud::ApiError => e
|
3313
3313
|
puts "Exception when calling ArchitectApi->get_flows: #{e}"
|
3314
3314
|
end
|
3315
|
-
|
3315
|
+
```
|
3316
3316
|
|
3317
3317
|
### Parameters
|
3318
3318
|
|
@@ -3352,7 +3352,7 @@ Name | Type | Description | Notes
|
|
3352
3352
|
|
3353
3353
|
<a name="get_flows_datatable"></a>
|
3354
3354
|
|
3355
|
-
##
|
3355
|
+
## [**DataTable**](DataTable.html) get_flows_datatable(datatable_id, opts)
|
3356
3356
|
|
3357
3357
|
|
3358
3358
|
|
@@ -3368,7 +3368,7 @@ Requires ANY permissions:
|
|
3368
3368
|
|
3369
3369
|
|
3370
3370
|
### Example
|
3371
|
-
|
3371
|
+
```{"language":"ruby"}
|
3372
3372
|
# load the gem
|
3373
3373
|
require 'purecloudplatformclientv2'
|
3374
3374
|
# setup authorization
|
@@ -3397,7 +3397,7 @@ begin
|
|
3397
3397
|
rescue PureCloud::ApiError => e
|
3398
3398
|
puts "Exception when calling ArchitectApi->get_flows_datatable: #{e}"
|
3399
3399
|
end
|
3400
|
-
|
3400
|
+
```
|
3401
3401
|
|
3402
3402
|
### Parameters
|
3403
3403
|
|
@@ -3421,7 +3421,7 @@ Name | Type | Description | Notes
|
|
3421
3421
|
|
3422
3422
|
<a name="get_flows_datatable_row"></a>
|
3423
3423
|
|
3424
|
-
##
|
3424
|
+
## Hash<String, Object>** get_flows_datatable_row(datatable_id, row_id, opts)
|
3425
3425
|
|
3426
3426
|
|
3427
3427
|
|
@@ -3437,7 +3437,7 @@ Requires ANY permissions:
|
|
3437
3437
|
|
3438
3438
|
|
3439
3439
|
### Example
|
3440
|
-
|
3440
|
+
```{"language":"ruby"}
|
3441
3441
|
# load the gem
|
3442
3442
|
require 'purecloudplatformclientv2'
|
3443
3443
|
# setup authorization
|
@@ -3468,7 +3468,7 @@ begin
|
|
3468
3468
|
rescue PureCloud::ApiError => e
|
3469
3469
|
puts "Exception when calling ArchitectApi->get_flows_datatable_row: #{e}"
|
3470
3470
|
end
|
3471
|
-
|
3471
|
+
```
|
3472
3472
|
|
3473
3473
|
### Parameters
|
3474
3474
|
|
@@ -3493,7 +3493,7 @@ Name | Type | Description | Notes
|
|
3493
3493
|
|
3494
3494
|
<a name="get_flows_datatable_rows"></a>
|
3495
3495
|
|
3496
|
-
##
|
3496
|
+
## [**DataTableRowEntityListing**](DataTableRowEntityListing.html) get_flows_datatable_rows(datatable_id, opts)
|
3497
3497
|
|
3498
3498
|
|
3499
3499
|
|
@@ -3509,7 +3509,7 @@ Requires ANY permissions:
|
|
3509
3509
|
|
3510
3510
|
|
3511
3511
|
### Example
|
3512
|
-
|
3512
|
+
```{"language":"ruby"}
|
3513
3513
|
# load the gem
|
3514
3514
|
require 'purecloudplatformclientv2'
|
3515
3515
|
# setup authorization
|
@@ -3540,7 +3540,7 @@ begin
|
|
3540
3540
|
rescue PureCloud::ApiError => e
|
3541
3541
|
puts "Exception when calling ArchitectApi->get_flows_datatable_rows: #{e}"
|
3542
3542
|
end
|
3543
|
-
|
3543
|
+
```
|
3544
3544
|
|
3545
3545
|
### Parameters
|
3546
3546
|
|
@@ -3566,7 +3566,7 @@ Name | Type | Description | Notes
|
|
3566
3566
|
|
3567
3567
|
<a name="get_flows_datatables"></a>
|
3568
3568
|
|
3569
|
-
##
|
3569
|
+
## [**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html) get_flows_datatables(opts)
|
3570
3570
|
|
3571
3571
|
|
3572
3572
|
|
@@ -3582,7 +3582,7 @@ Requires ANY permissions:
|
|
3582
3582
|
|
3583
3583
|
|
3584
3584
|
### Example
|
3585
|
-
|
3585
|
+
```{"language":"ruby"}
|
3586
3586
|
# load the gem
|
3587
3587
|
require 'purecloudplatformclientv2'
|
3588
3588
|
# setup authorization
|
@@ -3613,7 +3613,7 @@ begin
|
|
3613
3613
|
rescue PureCloud::ApiError => e
|
3614
3614
|
puts "Exception when calling ArchitectApi->get_flows_datatables: #{e}"
|
3615
3615
|
end
|
3616
|
-
|
3616
|
+
```
|
3617
3617
|
|
3618
3618
|
### Parameters
|
3619
3619
|
|
@@ -3640,7 +3640,7 @@ Name | Type | Description | Notes
|
|
3640
3640
|
|
3641
3641
|
<a name="get_flows_divisionviews"></a>
|
3642
3642
|
|
3643
|
-
##
|
3643
|
+
## [**FlowDivisionViewEntityListing**](FlowDivisionViewEntityListing.html) get_flows_divisionviews(opts)
|
3644
3644
|
|
3645
3645
|
|
3646
3646
|
|
@@ -3656,7 +3656,7 @@ Requires ANY permissions:
|
|
3656
3656
|
|
3657
3657
|
|
3658
3658
|
### Example
|
3659
|
-
|
3659
|
+
```{"language":"ruby"}
|
3660
3660
|
# load the gem
|
3661
3661
|
require 'purecloudplatformclientv2'
|
3662
3662
|
# setup authorization
|
@@ -3693,7 +3693,7 @@ begin
|
|
3693
3693
|
rescue PureCloud::ApiError => e
|
3694
3694
|
puts "Exception when calling ArchitectApi->get_flows_divisionviews: #{e}"
|
3695
3695
|
end
|
3696
|
-
|
3696
|
+
```
|
3697
3697
|
|
3698
3698
|
### Parameters
|
3699
3699
|
|
@@ -3726,7 +3726,7 @@ Name | Type | Description | Notes
|
|
3726
3726
|
|
3727
3727
|
<a name="post_architect_dependencytracking_build"></a>
|
3728
3728
|
|
3729
|
-
##
|
3729
|
+
## post_architect_dependencytracking_build
|
3730
3730
|
|
3731
3731
|
|
3732
3732
|
|
@@ -3742,7 +3742,7 @@ Requires ANY permissions:
|
|
3742
3742
|
|
3743
3743
|
|
3744
3744
|
### Example
|
3745
|
-
|
3745
|
+
```{"language":"ruby"}
|
3746
3746
|
# load the gem
|
3747
3747
|
require 'purecloudplatformclientv2'
|
3748
3748
|
# setup authorization
|
@@ -3764,7 +3764,7 @@ begin
|
|
3764
3764
|
rescue PureCloud::ApiError => e
|
3765
3765
|
puts "Exception when calling ArchitectApi->post_architect_dependencytracking_build: #{e}"
|
3766
3766
|
end
|
3767
|
-
|
3767
|
+
```
|
3768
3768
|
|
3769
3769
|
### Parameters
|
3770
3770
|
This endpoint does not need any parameter.
|
@@ -3784,7 +3784,7 @@ nil (empty response body)
|
|
3784
3784
|
|
3785
3785
|
<a name="post_architect_emergencygroups"></a>
|
3786
3786
|
|
3787
|
-
##
|
3787
|
+
## [**EmergencyGroup**](EmergencyGroup.html) post_architect_emergencygroups(body)
|
3788
3788
|
|
3789
3789
|
|
3790
3790
|
|
@@ -3800,7 +3800,7 @@ Requires ANY permissions:
|
|
3800
3800
|
|
3801
3801
|
|
3802
3802
|
### Example
|
3803
|
-
|
3803
|
+
```{"language":"ruby"}
|
3804
3804
|
# load the gem
|
3805
3805
|
require 'purecloudplatformclientv2'
|
3806
3806
|
# setup authorization
|
@@ -3826,7 +3826,7 @@ begin
|
|
3826
3826
|
rescue PureCloud::ApiError => e
|
3827
3827
|
puts "Exception when calling ArchitectApi->post_architect_emergencygroups: #{e}"
|
3828
3828
|
end
|
3829
|
-
|
3829
|
+
```
|
3830
3830
|
|
3831
3831
|
### Parameters
|
3832
3832
|
|
@@ -3849,7 +3849,7 @@ Name | Type | Description | Notes
|
|
3849
3849
|
|
3850
3850
|
<a name="post_architect_ivrs"></a>
|
3851
3851
|
|
3852
|
-
##
|
3852
|
+
## [**IVR**](IVR.html) post_architect_ivrs(body)
|
3853
3853
|
|
3854
3854
|
|
3855
3855
|
|
@@ -3865,7 +3865,7 @@ Requires ANY permissions:
|
|
3865
3865
|
|
3866
3866
|
|
3867
3867
|
### Example
|
3868
|
-
|
3868
|
+
```{"language":"ruby"}
|
3869
3869
|
# load the gem
|
3870
3870
|
require 'purecloudplatformclientv2'
|
3871
3871
|
# setup authorization
|
@@ -3891,7 +3891,7 @@ begin
|
|
3891
3891
|
rescue PureCloud::ApiError => e
|
3892
3892
|
puts "Exception when calling ArchitectApi->post_architect_ivrs: #{e}"
|
3893
3893
|
end
|
3894
|
-
|
3894
|
+
```
|
3895
3895
|
|
3896
3896
|
### Parameters
|
3897
3897
|
|
@@ -3914,7 +3914,7 @@ Name | Type | Description | Notes
|
|
3914
3914
|
|
3915
3915
|
<a name="post_architect_prompt_history"></a>
|
3916
3916
|
|
3917
|
-
##
|
3917
|
+
## [**Operation**](Operation.html) post_architect_prompt_history(prompt_id)
|
3918
3918
|
|
3919
3919
|
|
3920
3920
|
|
@@ -3930,7 +3930,7 @@ Requires ANY permissions:
|
|
3930
3930
|
|
3931
3931
|
|
3932
3932
|
### Example
|
3933
|
-
|
3933
|
+
```{"language":"ruby"}
|
3934
3934
|
# load the gem
|
3935
3935
|
require 'purecloudplatformclientv2'
|
3936
3936
|
# setup authorization
|
@@ -3956,7 +3956,7 @@ begin
|
|
3956
3956
|
rescue PureCloud::ApiError => e
|
3957
3957
|
puts "Exception when calling ArchitectApi->post_architect_prompt_history: #{e}"
|
3958
3958
|
end
|
3959
|
-
|
3959
|
+
```
|
3960
3960
|
|
3961
3961
|
### Parameters
|
3962
3962
|
|
@@ -3979,7 +3979,7 @@ Name | Type | Description | Notes
|
|
3979
3979
|
|
3980
3980
|
<a name="post_architect_prompt_resources"></a>
|
3981
3981
|
|
3982
|
-
##
|
3982
|
+
## [**PromptAsset**](PromptAsset.html) post_architect_prompt_resources(prompt_id, body)
|
3983
3983
|
|
3984
3984
|
|
3985
3985
|
|
@@ -3995,7 +3995,7 @@ Requires ANY permissions:
|
|
3995
3995
|
|
3996
3996
|
|
3997
3997
|
### Example
|
3998
|
-
|
3998
|
+
```{"language":"ruby"}
|
3999
3999
|
# load the gem
|
4000
4000
|
require 'purecloudplatformclientv2'
|
4001
4001
|
# setup authorization
|
@@ -4023,7 +4023,7 @@ begin
|
|
4023
4023
|
rescue PureCloud::ApiError => e
|
4024
4024
|
puts "Exception when calling ArchitectApi->post_architect_prompt_resources: #{e}"
|
4025
4025
|
end
|
4026
|
-
|
4026
|
+
```
|
4027
4027
|
|
4028
4028
|
### Parameters
|
4029
4029
|
|
@@ -4047,7 +4047,7 @@ Name | Type | Description | Notes
|
|
4047
4047
|
|
4048
4048
|
<a name="post_architect_prompts"></a>
|
4049
4049
|
|
4050
|
-
##
|
4050
|
+
## [**Prompt**](Prompt.html) post_architect_prompts(body)
|
4051
4051
|
|
4052
4052
|
|
4053
4053
|
|
@@ -4063,7 +4063,7 @@ Requires ANY permissions:
|
|
4063
4063
|
|
4064
4064
|
|
4065
4065
|
### Example
|
4066
|
-
|
4066
|
+
```{"language":"ruby"}
|
4067
4067
|
# load the gem
|
4068
4068
|
require 'purecloudplatformclientv2'
|
4069
4069
|
# setup authorization
|
@@ -4089,7 +4089,7 @@ begin
|
|
4089
4089
|
rescue PureCloud::ApiError => e
|
4090
4090
|
puts "Exception when calling ArchitectApi->post_architect_prompts: #{e}"
|
4091
4091
|
end
|
4092
|
-
|
4092
|
+
```
|
4093
4093
|
|
4094
4094
|
### Parameters
|
4095
4095
|
|
@@ -4112,7 +4112,7 @@ Name | Type | Description | Notes
|
|
4112
4112
|
|
4113
4113
|
<a name="post_architect_schedulegroups"></a>
|
4114
4114
|
|
4115
|
-
##
|
4115
|
+
## [**ScheduleGroup**](ScheduleGroup.html) post_architect_schedulegroups(body)
|
4116
4116
|
|
4117
4117
|
|
4118
4118
|
|
@@ -4128,7 +4128,7 @@ Requires ANY permissions:
|
|
4128
4128
|
|
4129
4129
|
|
4130
4130
|
### Example
|
4131
|
-
|
4131
|
+
```{"language":"ruby"}
|
4132
4132
|
# load the gem
|
4133
4133
|
require 'purecloudplatformclientv2'
|
4134
4134
|
# setup authorization
|
@@ -4154,7 +4154,7 @@ begin
|
|
4154
4154
|
rescue PureCloud::ApiError => e
|
4155
4155
|
puts "Exception when calling ArchitectApi->post_architect_schedulegroups: #{e}"
|
4156
4156
|
end
|
4157
|
-
|
4157
|
+
```
|
4158
4158
|
|
4159
4159
|
### Parameters
|
4160
4160
|
|
@@ -4177,7 +4177,7 @@ Name | Type | Description | Notes
|
|
4177
4177
|
|
4178
4178
|
<a name="post_architect_schedules"></a>
|
4179
4179
|
|
4180
|
-
##
|
4180
|
+
## [**Schedule**](Schedule.html) post_architect_schedules(body)
|
4181
4181
|
|
4182
4182
|
|
4183
4183
|
|
@@ -4193,7 +4193,7 @@ Requires ANY permissions:
|
|
4193
4193
|
|
4194
4194
|
|
4195
4195
|
### Example
|
4196
|
-
|
4196
|
+
```{"language":"ruby"}
|
4197
4197
|
# load the gem
|
4198
4198
|
require 'purecloudplatformclientv2'
|
4199
4199
|
# setup authorization
|
@@ -4219,7 +4219,7 @@ begin
|
|
4219
4219
|
rescue PureCloud::ApiError => e
|
4220
4220
|
puts "Exception when calling ArchitectApi->post_architect_schedules: #{e}"
|
4221
4221
|
end
|
4222
|
-
|
4222
|
+
```
|
4223
4223
|
|
4224
4224
|
### Parameters
|
4225
4225
|
|
@@ -4242,7 +4242,7 @@ Name | Type | Description | Notes
|
|
4242
4242
|
|
4243
4243
|
<a name="post_architect_systemprompt_history"></a>
|
4244
4244
|
|
4245
|
-
##
|
4245
|
+
## [**Operation**](Operation.html) post_architect_systemprompt_history(prompt_id)
|
4246
4246
|
|
4247
4247
|
|
4248
4248
|
|
@@ -4258,7 +4258,7 @@ Requires ANY permissions:
|
|
4258
4258
|
|
4259
4259
|
|
4260
4260
|
### Example
|
4261
|
-
|
4261
|
+
```{"language":"ruby"}
|
4262
4262
|
# load the gem
|
4263
4263
|
require 'purecloudplatformclientv2'
|
4264
4264
|
# setup authorization
|
@@ -4284,7 +4284,7 @@ begin
|
|
4284
4284
|
rescue PureCloud::ApiError => e
|
4285
4285
|
puts "Exception when calling ArchitectApi->post_architect_systemprompt_history: #{e}"
|
4286
4286
|
end
|
4287
|
-
|
4287
|
+
```
|
4288
4288
|
|
4289
4289
|
### Parameters
|
4290
4290
|
|
@@ -4307,7 +4307,7 @@ Name | Type | Description | Notes
|
|
4307
4307
|
|
4308
4308
|
<a name="post_architect_systemprompt_resources"></a>
|
4309
4309
|
|
4310
|
-
##
|
4310
|
+
## [**SystemPromptAsset**](SystemPromptAsset.html) post_architect_systemprompt_resources(prompt_id, body)
|
4311
4311
|
|
4312
4312
|
|
4313
4313
|
|
@@ -4323,7 +4323,7 @@ Requires ANY permissions:
|
|
4323
4323
|
|
4324
4324
|
|
4325
4325
|
### Example
|
4326
|
-
|
4326
|
+
```{"language":"ruby"}
|
4327
4327
|
# load the gem
|
4328
4328
|
require 'purecloudplatformclientv2'
|
4329
4329
|
# setup authorization
|
@@ -4351,7 +4351,7 @@ begin
|
|
4351
4351
|
rescue PureCloud::ApiError => e
|
4352
4352
|
puts "Exception when calling ArchitectApi->post_architect_systemprompt_resources: #{e}"
|
4353
4353
|
end
|
4354
|
-
|
4354
|
+
```
|
4355
4355
|
|
4356
4356
|
### Parameters
|
4357
4357
|
|
@@ -4375,7 +4375,7 @@ Name | Type | Description | Notes
|
|
4375
4375
|
|
4376
4376
|
<a name="post_flow_versions"></a>
|
4377
4377
|
|
4378
|
-
##
|
4378
|
+
## [**FlowVersion**](FlowVersion.html) post_flow_versions(flow_id, body)
|
4379
4379
|
|
4380
4380
|
|
4381
4381
|
|
@@ -4391,7 +4391,7 @@ Requires ANY permissions:
|
|
4391
4391
|
|
4392
4392
|
|
4393
4393
|
### Example
|
4394
|
-
|
4394
|
+
```{"language":"ruby"}
|
4395
4395
|
# load the gem
|
4396
4396
|
require 'purecloudplatformclientv2'
|
4397
4397
|
# setup authorization
|
@@ -4419,7 +4419,7 @@ begin
|
|
4419
4419
|
rescue PureCloud::ApiError => e
|
4420
4420
|
puts "Exception when calling ArchitectApi->post_flow_versions: #{e}"
|
4421
4421
|
end
|
4422
|
-
|
4422
|
+
```
|
4423
4423
|
|
4424
4424
|
### Parameters
|
4425
4425
|
|
@@ -4443,7 +4443,7 @@ Name | Type | Description | Notes
|
|
4443
4443
|
|
4444
4444
|
<a name="post_flows"></a>
|
4445
4445
|
|
4446
|
-
##
|
4446
|
+
## [**Flow**](Flow.html) post_flows(body)
|
4447
4447
|
|
4448
4448
|
|
4449
4449
|
|
@@ -4459,7 +4459,7 @@ Requires ANY permissions:
|
|
4459
4459
|
|
4460
4460
|
|
4461
4461
|
### Example
|
4462
|
-
|
4462
|
+
```{"language":"ruby"}
|
4463
4463
|
# load the gem
|
4464
4464
|
require 'purecloudplatformclientv2'
|
4465
4465
|
# setup authorization
|
@@ -4485,7 +4485,7 @@ begin
|
|
4485
4485
|
rescue PureCloud::ApiError => e
|
4486
4486
|
puts "Exception when calling ArchitectApi->post_flows: #{e}"
|
4487
4487
|
end
|
4488
|
-
|
4488
|
+
```
|
4489
4489
|
|
4490
4490
|
### Parameters
|
4491
4491
|
|
@@ -4508,7 +4508,7 @@ Name | Type | Description | Notes
|
|
4508
4508
|
|
4509
4509
|
<a name="post_flows_actions_checkin"></a>
|
4510
4510
|
|
4511
|
-
##
|
4511
|
+
## [**Flow**](Flow.html) post_flows_actions_checkin(flow)
|
4512
4512
|
|
4513
4513
|
|
4514
4514
|
|
@@ -4525,7 +4525,7 @@ Requires ANY permissions:
|
|
4525
4525
|
|
4526
4526
|
|
4527
4527
|
### Example
|
4528
|
-
|
4528
|
+
```{"language":"ruby"}
|
4529
4529
|
# load the gem
|
4530
4530
|
require 'purecloudplatformclientv2'
|
4531
4531
|
# setup authorization
|
@@ -4551,7 +4551,7 @@ begin
|
|
4551
4551
|
rescue PureCloud::ApiError => e
|
4552
4552
|
puts "Exception when calling ArchitectApi->post_flows_actions_checkin: #{e}"
|
4553
4553
|
end
|
4554
|
-
|
4554
|
+
```
|
4555
4555
|
|
4556
4556
|
### Parameters
|
4557
4557
|
|
@@ -4574,7 +4574,7 @@ Name | Type | Description | Notes
|
|
4574
4574
|
|
4575
4575
|
<a name="post_flows_actions_checkout"></a>
|
4576
4576
|
|
4577
|
-
##
|
4577
|
+
## [**Flow**](Flow.html) post_flows_actions_checkout(flow)
|
4578
4578
|
|
4579
4579
|
|
4580
4580
|
|
@@ -4590,7 +4590,7 @@ Requires ANY permissions:
|
|
4590
4590
|
|
4591
4591
|
|
4592
4592
|
### Example
|
4593
|
-
|
4593
|
+
```{"language":"ruby"}
|
4594
4594
|
# load the gem
|
4595
4595
|
require 'purecloudplatformclientv2'
|
4596
4596
|
# setup authorization
|
@@ -4616,7 +4616,7 @@ begin
|
|
4616
4616
|
rescue PureCloud::ApiError => e
|
4617
4617
|
puts "Exception when calling ArchitectApi->post_flows_actions_checkout: #{e}"
|
4618
4618
|
end
|
4619
|
-
|
4619
|
+
```
|
4620
4620
|
|
4621
4621
|
### Parameters
|
4622
4622
|
|
@@ -4639,7 +4639,7 @@ Name | Type | Description | Notes
|
|
4639
4639
|
|
4640
4640
|
<a name="post_flows_actions_deactivate"></a>
|
4641
4641
|
|
4642
|
-
##
|
4642
|
+
## [**Flow**](Flow.html) post_flows_actions_deactivate(flow)
|
4643
4643
|
|
4644
4644
|
|
4645
4645
|
|
@@ -4655,7 +4655,7 @@ Requires ANY permissions:
|
|
4655
4655
|
|
4656
4656
|
|
4657
4657
|
### Example
|
4658
|
-
|
4658
|
+
```{"language":"ruby"}
|
4659
4659
|
# load the gem
|
4660
4660
|
require 'purecloudplatformclientv2'
|
4661
4661
|
# setup authorization
|
@@ -4681,7 +4681,7 @@ begin
|
|
4681
4681
|
rescue PureCloud::ApiError => e
|
4682
4682
|
puts "Exception when calling ArchitectApi->post_flows_actions_deactivate: #{e}"
|
4683
4683
|
end
|
4684
|
-
|
4684
|
+
```
|
4685
4685
|
|
4686
4686
|
### Parameters
|
4687
4687
|
|
@@ -4704,7 +4704,7 @@ Name | Type | Description | Notes
|
|
4704
4704
|
|
4705
4705
|
<a name="post_flows_actions_publish"></a>
|
4706
4706
|
|
4707
|
-
##
|
4707
|
+
## [**Operation**](Operation.html) post_flows_actions_publish(flow, opts)
|
4708
4708
|
|
4709
4709
|
|
4710
4710
|
|
@@ -4721,7 +4721,7 @@ Requires ANY permissions:
|
|
4721
4721
|
|
4722
4722
|
|
4723
4723
|
### Example
|
4724
|
-
|
4724
|
+
```{"language":"ruby"}
|
4725
4725
|
# load the gem
|
4726
4726
|
require 'purecloudplatformclientv2'
|
4727
4727
|
# setup authorization
|
@@ -4750,7 +4750,7 @@ begin
|
|
4750
4750
|
rescue PureCloud::ApiError => e
|
4751
4751
|
puts "Exception when calling ArchitectApi->post_flows_actions_publish: #{e}"
|
4752
4752
|
end
|
4753
|
-
|
4753
|
+
```
|
4754
4754
|
|
4755
4755
|
### Parameters
|
4756
4756
|
|
@@ -4774,7 +4774,7 @@ Name | Type | Description | Notes
|
|
4774
4774
|
|
4775
4775
|
<a name="post_flows_actions_revert"></a>
|
4776
4776
|
|
4777
|
-
##
|
4777
|
+
## [**Flow**](Flow.html) post_flows_actions_revert(flow)
|
4778
4778
|
|
4779
4779
|
|
4780
4780
|
|
@@ -4790,7 +4790,7 @@ Requires ANY permissions:
|
|
4790
4790
|
|
4791
4791
|
|
4792
4792
|
### Example
|
4793
|
-
|
4793
|
+
```{"language":"ruby"}
|
4794
4794
|
# load the gem
|
4795
4795
|
require 'purecloudplatformclientv2'
|
4796
4796
|
# setup authorization
|
@@ -4816,7 +4816,7 @@ begin
|
|
4816
4816
|
rescue PureCloud::ApiError => e
|
4817
4817
|
puts "Exception when calling ArchitectApi->post_flows_actions_revert: #{e}"
|
4818
4818
|
end
|
4819
|
-
|
4819
|
+
```
|
4820
4820
|
|
4821
4821
|
### Parameters
|
4822
4822
|
|
@@ -4839,7 +4839,7 @@ Name | Type | Description | Notes
|
|
4839
4839
|
|
4840
4840
|
<a name="post_flows_actions_unlock"></a>
|
4841
4841
|
|
4842
|
-
##
|
4842
|
+
## [**Flow**](Flow.html) post_flows_actions_unlock(flow)
|
4843
4843
|
|
4844
4844
|
|
4845
4845
|
|
@@ -4855,7 +4855,7 @@ Requires ANY permissions:
|
|
4855
4855
|
|
4856
4856
|
|
4857
4857
|
### Example
|
4858
|
-
|
4858
|
+
```{"language":"ruby"}
|
4859
4859
|
# load the gem
|
4860
4860
|
require 'purecloudplatformclientv2'
|
4861
4861
|
# setup authorization
|
@@ -4881,7 +4881,7 @@ begin
|
|
4881
4881
|
rescue PureCloud::ApiError => e
|
4882
4882
|
puts "Exception when calling ArchitectApi->post_flows_actions_unlock: #{e}"
|
4883
4883
|
end
|
4884
|
-
|
4884
|
+
```
|
4885
4885
|
|
4886
4886
|
### Parameters
|
4887
4887
|
|
@@ -4904,7 +4904,7 @@ Name | Type | Description | Notes
|
|
4904
4904
|
|
4905
4905
|
<a name="post_flows_datatable_rows"></a>
|
4906
4906
|
|
4907
|
-
##
|
4907
|
+
## Hash<String, Object>** post_flows_datatable_rows(datatable_id, data_table_row)
|
4908
4908
|
|
4909
4909
|
|
4910
4910
|
|
@@ -4920,7 +4920,7 @@ Requires ANY permissions:
|
|
4920
4920
|
|
4921
4921
|
|
4922
4922
|
### Example
|
4923
|
-
|
4923
|
+
```{"language":"ruby"}
|
4924
4924
|
# load the gem
|
4925
4925
|
require 'purecloudplatformclientv2'
|
4926
4926
|
# setup authorization
|
@@ -4948,7 +4948,7 @@ begin
|
|
4948
4948
|
rescue PureCloud::ApiError => e
|
4949
4949
|
puts "Exception when calling ArchitectApi->post_flows_datatable_rows: #{e}"
|
4950
4950
|
end
|
4951
|
-
|
4951
|
+
```
|
4952
4952
|
|
4953
4953
|
### Parameters
|
4954
4954
|
|
@@ -4972,7 +4972,7 @@ Name | Type | Description | Notes
|
|
4972
4972
|
|
4973
4973
|
<a name="post_flows_datatables"></a>
|
4974
4974
|
|
4975
|
-
##
|
4975
|
+
## [**DataTable**](DataTable.html) post_flows_datatables(body)
|
4976
4976
|
|
4977
4977
|
|
4978
4978
|
|
@@ -4988,7 +4988,7 @@ Requires ANY permissions:
|
|
4988
4988
|
|
4989
4989
|
|
4990
4990
|
### Example
|
4991
|
-
|
4991
|
+
```{"language":"ruby"}
|
4992
4992
|
# load the gem
|
4993
4993
|
require 'purecloudplatformclientv2'
|
4994
4994
|
# setup authorization
|
@@ -5014,7 +5014,7 @@ begin
|
|
5014
5014
|
rescue PureCloud::ApiError => e
|
5015
5015
|
puts "Exception when calling ArchitectApi->post_flows_datatables: #{e}"
|
5016
5016
|
end
|
5017
|
-
|
5017
|
+
```
|
5018
5018
|
|
5019
5019
|
### Parameters
|
5020
5020
|
|
@@ -5037,7 +5037,7 @@ Name | Type | Description | Notes
|
|
5037
5037
|
|
5038
5038
|
<a name="put_architect_emergencygroup"></a>
|
5039
5039
|
|
5040
|
-
##
|
5040
|
+
## [**EmergencyGroup**](EmergencyGroup.html) put_architect_emergencygroup(emergency_group_id, body)
|
5041
5041
|
|
5042
5042
|
|
5043
5043
|
|
@@ -5053,7 +5053,7 @@ Requires ANY permissions:
|
|
5053
5053
|
|
5054
5054
|
|
5055
5055
|
### Example
|
5056
|
-
|
5056
|
+
```{"language":"ruby"}
|
5057
5057
|
# load the gem
|
5058
5058
|
require 'purecloudplatformclientv2'
|
5059
5059
|
# setup authorization
|
@@ -5081,7 +5081,7 @@ begin
|
|
5081
5081
|
rescue PureCloud::ApiError => e
|
5082
5082
|
puts "Exception when calling ArchitectApi->put_architect_emergencygroup: #{e}"
|
5083
5083
|
end
|
5084
|
-
|
5084
|
+
```
|
5085
5085
|
|
5086
5086
|
### Parameters
|
5087
5087
|
|
@@ -5105,7 +5105,7 @@ Name | Type | Description | Notes
|
|
5105
5105
|
|
5106
5106
|
<a name="put_architect_ivr"></a>
|
5107
5107
|
|
5108
|
-
##
|
5108
|
+
## [**IVR**](IVR.html) put_architect_ivr(ivr_id, body)
|
5109
5109
|
|
5110
5110
|
|
5111
5111
|
|
@@ -5121,7 +5121,7 @@ Requires ANY permissions:
|
|
5121
5121
|
|
5122
5122
|
|
5123
5123
|
### Example
|
5124
|
-
|
5124
|
+
```{"language":"ruby"}
|
5125
5125
|
# load the gem
|
5126
5126
|
require 'purecloudplatformclientv2'
|
5127
5127
|
# setup authorization
|
@@ -5149,7 +5149,7 @@ begin
|
|
5149
5149
|
rescue PureCloud::ApiError => e
|
5150
5150
|
puts "Exception when calling ArchitectApi->put_architect_ivr: #{e}"
|
5151
5151
|
end
|
5152
|
-
|
5152
|
+
```
|
5153
5153
|
|
5154
5154
|
### Parameters
|
5155
5155
|
|
@@ -5173,7 +5173,7 @@ Name | Type | Description | Notes
|
|
5173
5173
|
|
5174
5174
|
<a name="put_architect_prompt"></a>
|
5175
5175
|
|
5176
|
-
##
|
5176
|
+
## [**Prompt**](Prompt.html) put_architect_prompt(prompt_id, body)
|
5177
5177
|
|
5178
5178
|
|
5179
5179
|
|
@@ -5189,7 +5189,7 @@ Requires ANY permissions:
|
|
5189
5189
|
|
5190
5190
|
|
5191
5191
|
### Example
|
5192
|
-
|
5192
|
+
```{"language":"ruby"}
|
5193
5193
|
# load the gem
|
5194
5194
|
require 'purecloudplatformclientv2'
|
5195
5195
|
# setup authorization
|
@@ -5217,7 +5217,7 @@ begin
|
|
5217
5217
|
rescue PureCloud::ApiError => e
|
5218
5218
|
puts "Exception when calling ArchitectApi->put_architect_prompt: #{e}"
|
5219
5219
|
end
|
5220
|
-
|
5220
|
+
```
|
5221
5221
|
|
5222
5222
|
### Parameters
|
5223
5223
|
|
@@ -5241,7 +5241,7 @@ Name | Type | Description | Notes
|
|
5241
5241
|
|
5242
5242
|
<a name="put_architect_prompt_resource"></a>
|
5243
5243
|
|
5244
|
-
##
|
5244
|
+
## [**PromptAsset**](PromptAsset.html) put_architect_prompt_resource(prompt_id, language_code, body)
|
5245
5245
|
|
5246
5246
|
|
5247
5247
|
|
@@ -5257,7 +5257,7 @@ Requires ANY permissions:
|
|
5257
5257
|
|
5258
5258
|
|
5259
5259
|
### Example
|
5260
|
-
|
5260
|
+
```{"language":"ruby"}
|
5261
5261
|
# load the gem
|
5262
5262
|
require 'purecloudplatformclientv2'
|
5263
5263
|
# setup authorization
|
@@ -5287,7 +5287,7 @@ begin
|
|
5287
5287
|
rescue PureCloud::ApiError => e
|
5288
5288
|
puts "Exception when calling ArchitectApi->put_architect_prompt_resource: #{e}"
|
5289
5289
|
end
|
5290
|
-
|
5290
|
+
```
|
5291
5291
|
|
5292
5292
|
### Parameters
|
5293
5293
|
|
@@ -5312,7 +5312,7 @@ Name | Type | Description | Notes
|
|
5312
5312
|
|
5313
5313
|
<a name="put_architect_schedule"></a>
|
5314
5314
|
|
5315
|
-
##
|
5315
|
+
## [**Schedule**](Schedule.html) put_architect_schedule(schedule_id, body)
|
5316
5316
|
|
5317
5317
|
|
5318
5318
|
|
@@ -5328,7 +5328,7 @@ Requires ANY permissions:
|
|
5328
5328
|
|
5329
5329
|
|
5330
5330
|
### Example
|
5331
|
-
|
5331
|
+
```{"language":"ruby"}
|
5332
5332
|
# load the gem
|
5333
5333
|
require 'purecloudplatformclientv2'
|
5334
5334
|
# setup authorization
|
@@ -5356,7 +5356,7 @@ begin
|
|
5356
5356
|
rescue PureCloud::ApiError => e
|
5357
5357
|
puts "Exception when calling ArchitectApi->put_architect_schedule: #{e}"
|
5358
5358
|
end
|
5359
|
-
|
5359
|
+
```
|
5360
5360
|
|
5361
5361
|
### Parameters
|
5362
5362
|
|
@@ -5380,7 +5380,7 @@ Name | Type | Description | Notes
|
|
5380
5380
|
|
5381
5381
|
<a name="put_architect_schedulegroup"></a>
|
5382
5382
|
|
5383
|
-
##
|
5383
|
+
## [**ScheduleGroup**](ScheduleGroup.html) put_architect_schedulegroup(schedule_group_id, body)
|
5384
5384
|
|
5385
5385
|
|
5386
5386
|
|
@@ -5396,7 +5396,7 @@ Requires ANY permissions:
|
|
5396
5396
|
|
5397
5397
|
|
5398
5398
|
### Example
|
5399
|
-
|
5399
|
+
```{"language":"ruby"}
|
5400
5400
|
# load the gem
|
5401
5401
|
require 'purecloudplatformclientv2'
|
5402
5402
|
# setup authorization
|
@@ -5424,7 +5424,7 @@ begin
|
|
5424
5424
|
rescue PureCloud::ApiError => e
|
5425
5425
|
puts "Exception when calling ArchitectApi->put_architect_schedulegroup: #{e}"
|
5426
5426
|
end
|
5427
|
-
|
5427
|
+
```
|
5428
5428
|
|
5429
5429
|
### Parameters
|
5430
5430
|
|
@@ -5448,7 +5448,7 @@ Name | Type | Description | Notes
|
|
5448
5448
|
|
5449
5449
|
<a name="put_architect_systemprompt_resource"></a>
|
5450
5450
|
|
5451
|
-
##
|
5451
|
+
## [**SystemPromptAsset**](SystemPromptAsset.html) put_architect_systemprompt_resource(prompt_id, language_code, body)
|
5452
5452
|
|
5453
5453
|
|
5454
5454
|
|
@@ -5464,7 +5464,7 @@ Requires ANY permissions:
|
|
5464
5464
|
|
5465
5465
|
|
5466
5466
|
### Example
|
5467
|
-
|
5467
|
+
```{"language":"ruby"}
|
5468
5468
|
# load the gem
|
5469
5469
|
require 'purecloudplatformclientv2'
|
5470
5470
|
# setup authorization
|
@@ -5494,7 +5494,7 @@ begin
|
|
5494
5494
|
rescue PureCloud::ApiError => e
|
5495
5495
|
puts "Exception when calling ArchitectApi->put_architect_systemprompt_resource: #{e}"
|
5496
5496
|
end
|
5497
|
-
|
5497
|
+
```
|
5498
5498
|
|
5499
5499
|
### Parameters
|
5500
5500
|
|
@@ -5519,7 +5519,7 @@ Name | Type | Description | Notes
|
|
5519
5519
|
|
5520
5520
|
<a name="put_flow"></a>
|
5521
5521
|
|
5522
|
-
##
|
5522
|
+
## [**Flow**](Flow.html) put_flow(flow_id, body)
|
5523
5523
|
|
5524
5524
|
|
5525
5525
|
|
@@ -5535,7 +5535,7 @@ Requires ANY permissions:
|
|
5535
5535
|
|
5536
5536
|
|
5537
5537
|
### Example
|
5538
|
-
|
5538
|
+
```{"language":"ruby"}
|
5539
5539
|
# load the gem
|
5540
5540
|
require 'purecloudplatformclientv2'
|
5541
5541
|
# setup authorization
|
@@ -5563,7 +5563,7 @@ begin
|
|
5563
5563
|
rescue PureCloud::ApiError => e
|
5564
5564
|
puts "Exception when calling ArchitectApi->put_flow: #{e}"
|
5565
5565
|
end
|
5566
|
-
|
5566
|
+
```
|
5567
5567
|
|
5568
5568
|
### Parameters
|
5569
5569
|
|
@@ -5587,7 +5587,7 @@ Name | Type | Description | Notes
|
|
5587
5587
|
|
5588
5588
|
<a name="put_flows_datatable"></a>
|
5589
5589
|
|
5590
|
-
##
|
5590
|
+
## [**DataTable**](DataTable.html) put_flows_datatable(datatable_id, opts)
|
5591
5591
|
|
5592
5592
|
|
5593
5593
|
|
@@ -5603,7 +5603,7 @@ Requires ANY permissions:
|
|
5603
5603
|
|
5604
5604
|
|
5605
5605
|
### Example
|
5606
|
-
|
5606
|
+
```{"language":"ruby"}
|
5607
5607
|
# load the gem
|
5608
5608
|
require 'purecloudplatformclientv2'
|
5609
5609
|
# setup authorization
|
@@ -5633,7 +5633,7 @@ begin
|
|
5633
5633
|
rescue PureCloud::ApiError => e
|
5634
5634
|
puts "Exception when calling ArchitectApi->put_flows_datatable: #{e}"
|
5635
5635
|
end
|
5636
|
-
|
5636
|
+
```
|
5637
5637
|
|
5638
5638
|
### Parameters
|
5639
5639
|
|
@@ -5658,7 +5658,7 @@ Name | Type | Description | Notes
|
|
5658
5658
|
|
5659
5659
|
<a name="put_flows_datatable_row"></a>
|
5660
5660
|
|
5661
|
-
##
|
5661
|
+
## Hash<String, Object>** put_flows_datatable_row(datatable_id, row_id, opts)
|
5662
5662
|
|
5663
5663
|
|
5664
5664
|
|
@@ -5674,7 +5674,7 @@ Requires ANY permissions:
|
|
5674
5674
|
|
5675
5675
|
|
5676
5676
|
### Example
|
5677
|
-
|
5677
|
+
```{"language":"ruby"}
|
5678
5678
|
# load the gem
|
5679
5679
|
require 'purecloudplatformclientv2'
|
5680
5680
|
# setup authorization
|
@@ -5705,7 +5705,7 @@ begin
|
|
5705
5705
|
rescue PureCloud::ApiError => e
|
5706
5706
|
puts "Exception when calling ArchitectApi->put_flows_datatable_row: #{e}"
|
5707
5707
|
end
|
5708
|
-
|
5708
|
+
```
|
5709
5709
|
|
5710
5710
|
### Parameters
|
5711
5711
|
|