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/AuthorizationApi.md
CHANGED
@@ -46,7 +46,7 @@ Method | Description
|
|
46
46
|
|
47
47
|
<a name="delete_authorization_division"></a>
|
48
48
|
|
49
|
-
##
|
49
|
+
## delete_authorization_division(division_id)
|
50
50
|
|
51
51
|
|
52
52
|
|
@@ -62,7 +62,7 @@ Requires ANY permissions:
|
|
62
62
|
|
63
63
|
|
64
64
|
### Example
|
65
|
-
|
65
|
+
```{"language":"ruby"}
|
66
66
|
# load the gem
|
67
67
|
require 'purecloudplatformclientv2'
|
68
68
|
# setup authorization
|
@@ -87,7 +87,7 @@ begin
|
|
87
87
|
rescue PureCloud::ApiError => e
|
88
88
|
puts "Exception when calling AuthorizationApi->delete_authorization_division: #{e}"
|
89
89
|
end
|
90
|
-
|
90
|
+
```
|
91
91
|
|
92
92
|
### Parameters
|
93
93
|
|
@@ -110,7 +110,7 @@ nil (empty response body)
|
|
110
110
|
|
111
111
|
<a name="delete_authorization_role"></a>
|
112
112
|
|
113
|
-
##
|
113
|
+
## delete_authorization_role(role_id)
|
114
114
|
|
115
115
|
|
116
116
|
|
@@ -128,7 +128,7 @@ Requires ANY permissions:
|
|
128
128
|
|
129
129
|
|
130
130
|
### Example
|
131
|
-
|
131
|
+
```{"language":"ruby"}
|
132
132
|
# load the gem
|
133
133
|
require 'purecloudplatformclientv2'
|
134
134
|
# setup authorization
|
@@ -153,7 +153,7 @@ begin
|
|
153
153
|
rescue PureCloud::ApiError => e
|
154
154
|
puts "Exception when calling AuthorizationApi->delete_authorization_role: #{e}"
|
155
155
|
end
|
156
|
-
|
156
|
+
```
|
157
157
|
|
158
158
|
### Parameters
|
159
159
|
|
@@ -176,7 +176,7 @@ nil (empty response body)
|
|
176
176
|
|
177
177
|
<a name="delete_authorization_subject_division_role"></a>
|
178
178
|
|
179
|
-
##
|
179
|
+
## delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
180
180
|
|
181
181
|
|
182
182
|
|
@@ -192,7 +192,7 @@ Requires ANY permissions:
|
|
192
192
|
|
193
193
|
|
194
194
|
### Example
|
195
|
-
|
195
|
+
```{"language":"ruby"}
|
196
196
|
# load the gem
|
197
197
|
require 'purecloudplatformclientv2'
|
198
198
|
# setup authorization
|
@@ -221,7 +221,7 @@ begin
|
|
221
221
|
rescue PureCloud::ApiError => e
|
222
222
|
puts "Exception when calling AuthorizationApi->delete_authorization_subject_division_role: #{e}"
|
223
223
|
end
|
224
|
-
|
224
|
+
```
|
225
225
|
|
226
226
|
### Parameters
|
227
227
|
|
@@ -246,7 +246,7 @@ nil (empty response body)
|
|
246
246
|
|
247
247
|
<a name="delete_user_roles"></a>
|
248
248
|
|
249
|
-
##
|
249
|
+
## delete_user_roles(user_id)
|
250
250
|
|
251
251
|
|
252
252
|
|
@@ -264,7 +264,7 @@ Requires ANY permissions:
|
|
264
264
|
|
265
265
|
|
266
266
|
### Example
|
267
|
-
|
267
|
+
```{"language":"ruby"}
|
268
268
|
# load the gem
|
269
269
|
require 'purecloudplatformclientv2'
|
270
270
|
# setup authorization
|
@@ -289,7 +289,7 @@ begin
|
|
289
289
|
rescue PureCloud::ApiError => e
|
290
290
|
puts "Exception when calling AuthorizationApi->delete_user_roles: #{e}"
|
291
291
|
end
|
292
|
-
|
292
|
+
```
|
293
293
|
|
294
294
|
### Parameters
|
295
295
|
|
@@ -312,7 +312,7 @@ nil (empty response body)
|
|
312
312
|
|
313
313
|
<a name="get_authorization_division"></a>
|
314
314
|
|
315
|
-
##
|
315
|
+
## [**AuthzDivision**](AuthzDivision.html) get_authorization_division(division_id, opts)
|
316
316
|
|
317
317
|
|
318
318
|
|
@@ -327,7 +327,7 @@ Requires NO permissions:
|
|
327
327
|
|
328
328
|
|
329
329
|
### Example
|
330
|
-
|
330
|
+
```{"language":"ruby"}
|
331
331
|
# load the gem
|
332
332
|
require 'purecloudplatformclientv2'
|
333
333
|
# setup authorization
|
@@ -356,7 +356,7 @@ begin
|
|
356
356
|
rescue PureCloud::ApiError => e
|
357
357
|
puts "Exception when calling AuthorizationApi->get_authorization_division: #{e}"
|
358
358
|
end
|
359
|
-
|
359
|
+
```
|
360
360
|
|
361
361
|
### Parameters
|
362
362
|
|
@@ -380,7 +380,7 @@ Name | Type | Description | Notes
|
|
380
380
|
|
381
381
|
<a name="get_authorization_divisions"></a>
|
382
382
|
|
383
|
-
##
|
383
|
+
## [**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html) get_authorization_divisions(opts)
|
384
384
|
|
385
385
|
|
386
386
|
|
@@ -395,7 +395,7 @@ Requires NO permissions:
|
|
395
395
|
|
396
396
|
|
397
397
|
### Example
|
398
|
-
|
398
|
+
```{"language":"ruby"}
|
399
399
|
# load the gem
|
400
400
|
require 'purecloudplatformclientv2'
|
401
401
|
# setup authorization
|
@@ -430,7 +430,7 @@ begin
|
|
430
430
|
rescue PureCloud::ApiError => e
|
431
431
|
puts "Exception when calling AuthorizationApi->get_authorization_divisions: #{e}"
|
432
432
|
end
|
433
|
-
|
433
|
+
```
|
434
434
|
|
435
435
|
### Parameters
|
436
436
|
|
@@ -461,7 +461,7 @@ Name | Type | Description | Notes
|
|
461
461
|
|
462
462
|
<a name="get_authorization_divisions_home"></a>
|
463
463
|
|
464
|
-
##
|
464
|
+
## [**AuthzDivision**](AuthzDivision.html) get_authorization_divisions_home
|
465
465
|
|
466
466
|
|
467
467
|
|
@@ -476,7 +476,7 @@ Requires NO permissions:
|
|
476
476
|
|
477
477
|
|
478
478
|
### Example
|
479
|
-
|
479
|
+
```{"language":"ruby"}
|
480
480
|
# load the gem
|
481
481
|
require 'purecloudplatformclientv2'
|
482
482
|
# setup authorization
|
@@ -499,7 +499,7 @@ begin
|
|
499
499
|
rescue PureCloud::ApiError => e
|
500
500
|
puts "Exception when calling AuthorizationApi->get_authorization_divisions_home: #{e}"
|
501
501
|
end
|
502
|
-
|
502
|
+
```
|
503
503
|
|
504
504
|
### Parameters
|
505
505
|
This endpoint does not need any parameter.
|
@@ -519,7 +519,7 @@ This endpoint does not need any parameter.
|
|
519
519
|
|
520
520
|
<a name="get_authorization_divisions_limit"></a>
|
521
521
|
|
522
|
-
##
|
522
|
+
## Integer** get_authorization_divisions_limit
|
523
523
|
|
524
524
|
|
525
525
|
|
@@ -534,7 +534,7 @@ Requires NO permissions:
|
|
534
534
|
|
535
535
|
|
536
536
|
### Example
|
537
|
-
|
537
|
+
```{"language":"ruby"}
|
538
538
|
# load the gem
|
539
539
|
require 'purecloudplatformclientv2'
|
540
540
|
# setup authorization
|
@@ -557,7 +557,7 @@ begin
|
|
557
557
|
rescue PureCloud::ApiError => e
|
558
558
|
puts "Exception when calling AuthorizationApi->get_authorization_divisions_limit: #{e}"
|
559
559
|
end
|
560
|
-
|
560
|
+
```
|
561
561
|
|
562
562
|
### Parameters
|
563
563
|
This endpoint does not need any parameter.
|
@@ -577,7 +577,7 @@ This endpoint does not need any parameter.
|
|
577
577
|
|
578
578
|
<a name="get_authorization_divisionspermitted_me"></a>
|
579
579
|
|
580
|
-
##
|
580
|
+
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
581
581
|
|
582
582
|
|
583
583
|
|
@@ -592,7 +592,7 @@ Requires NO permissions:
|
|
592
592
|
|
593
593
|
|
594
594
|
### Example
|
595
|
-
|
595
|
+
```{"language":"ruby"}
|
596
596
|
# load the gem
|
597
597
|
require 'purecloudplatformclientv2'
|
598
598
|
# setup authorization
|
@@ -621,7 +621,7 @@ begin
|
|
621
621
|
rescue PureCloud::ApiError => e
|
622
622
|
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_me: #{e}"
|
623
623
|
end
|
624
|
-
|
624
|
+
```
|
625
625
|
|
626
626
|
### Parameters
|
627
627
|
|
@@ -645,7 +645,7 @@ Name | Type | Description | Notes
|
|
645
645
|
|
646
646
|
<a name="get_authorization_divisionspermitted_subject_id"></a>
|
647
647
|
|
648
|
-
##
|
648
|
+
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
649
649
|
|
650
650
|
|
651
651
|
|
@@ -660,7 +660,7 @@ Requires NO permissions:
|
|
660
660
|
|
661
661
|
|
662
662
|
### Example
|
663
|
-
|
663
|
+
```{"language":"ruby"}
|
664
664
|
# load the gem
|
665
665
|
require 'purecloudplatformclientv2'
|
666
666
|
# setup authorization
|
@@ -691,7 +691,7 @@ begin
|
|
691
691
|
rescue PureCloud::ApiError => e
|
692
692
|
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_subject_id: #{e}"
|
693
693
|
end
|
694
|
-
|
694
|
+
```
|
695
695
|
|
696
696
|
### Parameters
|
697
697
|
|
@@ -716,7 +716,7 @@ Name | Type | Description | Notes
|
|
716
716
|
|
717
717
|
<a name="get_authorization_permissions"></a>
|
718
718
|
|
719
|
-
##
|
719
|
+
## [**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
|
720
720
|
|
721
721
|
|
722
722
|
|
@@ -731,7 +731,7 @@ Requires NO permissions:
|
|
731
731
|
|
732
732
|
|
733
733
|
### Example
|
734
|
-
|
734
|
+
```{"language":"ruby"}
|
735
735
|
# load the gem
|
736
736
|
require 'purecloudplatformclientv2'
|
737
737
|
# setup authorization
|
@@ -759,7 +759,7 @@ begin
|
|
759
759
|
rescue PureCloud::ApiError => e
|
760
760
|
puts "Exception when calling AuthorizationApi->get_authorization_permissions: #{e}"
|
761
761
|
end
|
762
|
-
|
762
|
+
```
|
763
763
|
|
764
764
|
### Parameters
|
765
765
|
|
@@ -783,7 +783,7 @@ Name | Type | Description | Notes
|
|
783
783
|
|
784
784
|
<a name="get_authorization_products"></a>
|
785
785
|
|
786
|
-
##
|
786
|
+
## [**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
|
787
787
|
|
788
788
|
|
789
789
|
|
@@ -798,7 +798,7 @@ Requires NO permissions:
|
|
798
798
|
|
799
799
|
|
800
800
|
### Example
|
801
|
-
|
801
|
+
```{"language":"ruby"}
|
802
802
|
# load the gem
|
803
803
|
require 'purecloudplatformclientv2'
|
804
804
|
# setup authorization
|
@@ -821,7 +821,7 @@ begin
|
|
821
821
|
rescue PureCloud::ApiError => e
|
822
822
|
puts "Exception when calling AuthorizationApi->get_authorization_products: #{e}"
|
823
823
|
end
|
824
|
-
|
824
|
+
```
|
825
825
|
|
826
826
|
### Parameters
|
827
827
|
This endpoint does not need any parameter.
|
@@ -841,7 +841,7 @@ This endpoint does not need any parameter.
|
|
841
841
|
|
842
842
|
<a name="get_authorization_role"></a>
|
843
843
|
|
844
|
-
##
|
844
|
+
## [**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
|
845
845
|
|
846
846
|
|
847
847
|
|
@@ -857,7 +857,7 @@ Requires ANY permissions:
|
|
857
857
|
|
858
858
|
|
859
859
|
### Example
|
860
|
-
|
860
|
+
```{"language":"ruby"}
|
861
861
|
# load the gem
|
862
862
|
require 'purecloudplatformclientv2'
|
863
863
|
# setup authorization
|
@@ -883,7 +883,7 @@ begin
|
|
883
883
|
rescue PureCloud::ApiError => e
|
884
884
|
puts "Exception when calling AuthorizationApi->get_authorization_role: #{e}"
|
885
885
|
end
|
886
|
-
|
886
|
+
```
|
887
887
|
|
888
888
|
### Parameters
|
889
889
|
|
@@ -906,7 +906,7 @@ Name | Type | Description | Notes
|
|
906
906
|
|
907
907
|
<a name="get_authorization_role_comparedefault_right_role_id"></a>
|
908
908
|
|
909
|
-
##
|
909
|
+
## [**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
|
910
910
|
|
911
911
|
|
912
912
|
|
@@ -922,7 +922,7 @@ Requires ANY permissions:
|
|
922
922
|
|
923
923
|
|
924
924
|
### Example
|
925
|
-
|
925
|
+
```{"language":"ruby"}
|
926
926
|
# load the gem
|
927
927
|
require 'purecloudplatformclientv2'
|
928
928
|
# setup authorization
|
@@ -950,7 +950,7 @@ begin
|
|
950
950
|
rescue PureCloud::ApiError => e
|
951
951
|
puts "Exception when calling AuthorizationApi->get_authorization_role_comparedefault_right_role_id: #{e}"
|
952
952
|
end
|
953
|
-
|
953
|
+
```
|
954
954
|
|
955
955
|
### Parameters
|
956
956
|
|
@@ -974,7 +974,7 @@ Name | Type | Description | Notes
|
|
974
974
|
|
975
975
|
<a name="get_authorization_role_subjectgrants"></a>
|
976
976
|
|
977
|
-
##
|
977
|
+
## [**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html) get_authorization_role_subjectgrants(role_id, opts)
|
978
978
|
|
979
979
|
|
980
980
|
|
@@ -990,7 +990,7 @@ Requires ANY permissions:
|
|
990
990
|
|
991
991
|
|
992
992
|
### Example
|
993
|
-
|
993
|
+
```{"language":"ruby"}
|
994
994
|
# load the gem
|
995
995
|
require 'purecloudplatformclientv2'
|
996
996
|
# setup authorization
|
@@ -1024,7 +1024,7 @@ begin
|
|
1024
1024
|
rescue PureCloud::ApiError => e
|
1025
1025
|
puts "Exception when calling AuthorizationApi->get_authorization_role_subjectgrants: #{e}"
|
1026
1026
|
end
|
1027
|
-
|
1027
|
+
```
|
1028
1028
|
|
1029
1029
|
### Parameters
|
1030
1030
|
|
@@ -1053,7 +1053,7 @@ Name | Type | Description | Notes
|
|
1053
1053
|
|
1054
1054
|
<a name="get_authorization_role_users"></a>
|
1055
1055
|
|
1056
|
-
##
|
1056
|
+
## [**UserEntityListing**](UserEntityListing.html) get_authorization_role_users(role_id, opts)
|
1057
1057
|
|
1058
1058
|
|
1059
1059
|
|
@@ -1068,7 +1068,7 @@ Requires NO permissions:
|
|
1068
1068
|
|
1069
1069
|
|
1070
1070
|
### Example
|
1071
|
-
|
1071
|
+
```{"language":"ruby"}
|
1072
1072
|
# load the gem
|
1073
1073
|
require 'purecloudplatformclientv2'
|
1074
1074
|
# setup authorization
|
@@ -1098,7 +1098,7 @@ begin
|
|
1098
1098
|
rescue PureCloud::ApiError => e
|
1099
1099
|
puts "Exception when calling AuthorizationApi->get_authorization_role_users: #{e}"
|
1100
1100
|
end
|
1101
|
-
|
1101
|
+
```
|
1102
1102
|
|
1103
1103
|
### Parameters
|
1104
1104
|
|
@@ -1123,7 +1123,7 @@ Name | Type | Description | Notes
|
|
1123
1123
|
|
1124
1124
|
<a name="get_authorization_roles"></a>
|
1125
1125
|
|
1126
|
-
##
|
1126
|
+
## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
|
1127
1127
|
|
1128
1128
|
|
1129
1129
|
|
@@ -1139,7 +1139,7 @@ Requires ANY permissions:
|
|
1139
1139
|
|
1140
1140
|
|
1141
1141
|
### Example
|
1142
|
-
|
1142
|
+
```{"language":"ruby"}
|
1143
1143
|
# load the gem
|
1144
1144
|
require 'purecloudplatformclientv2'
|
1145
1145
|
# setup authorization
|
@@ -1176,7 +1176,7 @@ begin
|
|
1176
1176
|
rescue PureCloud::ApiError => e
|
1177
1177
|
puts "Exception when calling AuthorizationApi->get_authorization_roles: #{e}"
|
1178
1178
|
end
|
1179
|
-
|
1179
|
+
```
|
1180
1180
|
|
1181
1181
|
### Parameters
|
1182
1182
|
|
@@ -1209,7 +1209,7 @@ Name | Type | Description | Notes
|
|
1209
1209
|
|
1210
1210
|
<a name="get_authorization_subject"></a>
|
1211
1211
|
|
1212
|
-
##
|
1212
|
+
## [**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
|
1213
1213
|
|
1214
1214
|
|
1215
1215
|
|
@@ -1225,7 +1225,7 @@ Requires ANY permissions:
|
|
1225
1225
|
|
1226
1226
|
|
1227
1227
|
### Example
|
1228
|
-
|
1228
|
+
```{"language":"ruby"}
|
1229
1229
|
# load the gem
|
1230
1230
|
require 'purecloudplatformclientv2'
|
1231
1231
|
# setup authorization
|
@@ -1251,7 +1251,7 @@ begin
|
|
1251
1251
|
rescue PureCloud::ApiError => e
|
1252
1252
|
puts "Exception when calling AuthorizationApi->get_authorization_subject: #{e}"
|
1253
1253
|
end
|
1254
|
-
|
1254
|
+
```
|
1255
1255
|
|
1256
1256
|
### Parameters
|
1257
1257
|
|
@@ -1274,7 +1274,7 @@ Name | Type | Description | Notes
|
|
1274
1274
|
|
1275
1275
|
<a name="get_authorization_subjects_me"></a>
|
1276
1276
|
|
1277
|
-
##
|
1277
|
+
## [**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
|
1278
1278
|
|
1279
1279
|
|
1280
1280
|
|
@@ -1289,7 +1289,7 @@ Requires NO permissions:
|
|
1289
1289
|
|
1290
1290
|
|
1291
1291
|
### Example
|
1292
|
-
|
1292
|
+
```{"language":"ruby"}
|
1293
1293
|
# load the gem
|
1294
1294
|
require 'purecloudplatformclientv2'
|
1295
1295
|
# setup authorization
|
@@ -1312,7 +1312,7 @@ begin
|
|
1312
1312
|
rescue PureCloud::ApiError => e
|
1313
1313
|
puts "Exception when calling AuthorizationApi->get_authorization_subjects_me: #{e}"
|
1314
1314
|
end
|
1315
|
-
|
1315
|
+
```
|
1316
1316
|
|
1317
1317
|
### Parameters
|
1318
1318
|
This endpoint does not need any parameter.
|
@@ -1332,7 +1332,7 @@ This endpoint does not need any parameter.
|
|
1332
1332
|
|
1333
1333
|
<a name="get_user_roles"></a>
|
1334
1334
|
|
1335
|
-
##
|
1335
|
+
## [**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
|
1336
1336
|
|
1337
1337
|
|
1338
1338
|
|
@@ -1348,7 +1348,7 @@ Requires ANY permissions:
|
|
1348
1348
|
|
1349
1349
|
|
1350
1350
|
### Example
|
1351
|
-
|
1351
|
+
```{"language":"ruby"}
|
1352
1352
|
# load the gem
|
1353
1353
|
require 'purecloudplatformclientv2'
|
1354
1354
|
# setup authorization
|
@@ -1374,7 +1374,7 @@ begin
|
|
1374
1374
|
rescue PureCloud::ApiError => e
|
1375
1375
|
puts "Exception when calling AuthorizationApi->get_user_roles: #{e}"
|
1376
1376
|
end
|
1377
|
-
|
1377
|
+
```
|
1378
1378
|
|
1379
1379
|
### Parameters
|
1380
1380
|
|
@@ -1397,7 +1397,7 @@ Name | Type | Description | Notes
|
|
1397
1397
|
|
1398
1398
|
<a name="patch_authorization_role"></a>
|
1399
1399
|
|
1400
|
-
##
|
1400
|
+
## [**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
|
1401
1401
|
|
1402
1402
|
|
1403
1403
|
|
@@ -1415,7 +1415,7 @@ Requires ANY permissions:
|
|
1415
1415
|
|
1416
1416
|
|
1417
1417
|
### Example
|
1418
|
-
|
1418
|
+
```{"language":"ruby"}
|
1419
1419
|
# load the gem
|
1420
1420
|
require 'purecloudplatformclientv2'
|
1421
1421
|
# setup authorization
|
@@ -1443,7 +1443,7 @@ begin
|
|
1443
1443
|
rescue PureCloud::ApiError => e
|
1444
1444
|
puts "Exception when calling AuthorizationApi->patch_authorization_role: #{e}"
|
1445
1445
|
end
|
1446
|
-
|
1446
|
+
```
|
1447
1447
|
|
1448
1448
|
### Parameters
|
1449
1449
|
|
@@ -1467,7 +1467,7 @@ Name | Type | Description | Notes
|
|
1467
1467
|
|
1468
1468
|
<a name="post_authorization_division_object"></a>
|
1469
1469
|
|
1470
|
-
##
|
1470
|
+
## post_authorization_division_object(division_id, object_type, body)
|
1471
1471
|
|
1472
1472
|
|
1473
1473
|
|
@@ -1482,7 +1482,7 @@ Requires NO permissions:
|
|
1482
1482
|
|
1483
1483
|
|
1484
1484
|
### Example
|
1485
|
-
|
1485
|
+
```{"language":"ruby"}
|
1486
1486
|
# load the gem
|
1487
1487
|
require 'purecloudplatformclientv2'
|
1488
1488
|
# setup authorization
|
@@ -1511,7 +1511,7 @@ begin
|
|
1511
1511
|
rescue PureCloud::ApiError => e
|
1512
1512
|
puts "Exception when calling AuthorizationApi->post_authorization_division_object: #{e}"
|
1513
1513
|
end
|
1514
|
-
|
1514
|
+
```
|
1515
1515
|
|
1516
1516
|
### Parameters
|
1517
1517
|
|
@@ -1536,7 +1536,7 @@ nil (empty response body)
|
|
1536
1536
|
|
1537
1537
|
<a name="post_authorization_divisions"></a>
|
1538
1538
|
|
1539
|
-
##
|
1539
|
+
## [**AuthzDivision**](AuthzDivision.html) post_authorization_divisions(body)
|
1540
1540
|
|
1541
1541
|
|
1542
1542
|
|
@@ -1553,7 +1553,7 @@ Requires ALL permissions:
|
|
1553
1553
|
|
1554
1554
|
|
1555
1555
|
### Example
|
1556
|
-
|
1556
|
+
```{"language":"ruby"}
|
1557
1557
|
# load the gem
|
1558
1558
|
require 'purecloudplatformclientv2'
|
1559
1559
|
# setup authorization
|
@@ -1579,7 +1579,7 @@ begin
|
|
1579
1579
|
rescue PureCloud::ApiError => e
|
1580
1580
|
puts "Exception when calling AuthorizationApi->post_authorization_divisions: #{e}"
|
1581
1581
|
end
|
1582
|
-
|
1582
|
+
```
|
1583
1583
|
|
1584
1584
|
### Parameters
|
1585
1585
|
|
@@ -1602,7 +1602,7 @@ Name | Type | Description | Notes
|
|
1602
1602
|
|
1603
1603
|
<a name="post_authorization_role"></a>
|
1604
1604
|
|
1605
|
-
##
|
1605
|
+
## post_authorization_role(role_id, body, opts)
|
1606
1606
|
|
1607
1607
|
|
1608
1608
|
|
@@ -1618,7 +1618,7 @@ Requires ANY permissions:
|
|
1618
1618
|
|
1619
1619
|
|
1620
1620
|
### Example
|
1621
|
-
|
1621
|
+
```{"language":"ruby"}
|
1622
1622
|
# load the gem
|
1623
1623
|
require 'purecloudplatformclientv2'
|
1624
1624
|
# setup authorization
|
@@ -1648,7 +1648,7 @@ begin
|
|
1648
1648
|
rescue PureCloud::ApiError => e
|
1649
1649
|
puts "Exception when calling AuthorizationApi->post_authorization_role: #{e}"
|
1650
1650
|
end
|
1651
|
-
|
1651
|
+
```
|
1652
1652
|
|
1653
1653
|
### Parameters
|
1654
1654
|
|
@@ -1673,7 +1673,7 @@ nil (empty response body)
|
|
1673
1673
|
|
1674
1674
|
<a name="post_authorization_role_comparedefault_right_role_id"></a>
|
1675
1675
|
|
1676
|
-
##
|
1676
|
+
## [**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
|
1677
1677
|
|
1678
1678
|
|
1679
1679
|
|
@@ -1689,7 +1689,7 @@ Requires ANY permissions:
|
|
1689
1689
|
|
1690
1690
|
|
1691
1691
|
### Example
|
1692
|
-
|
1692
|
+
```{"language":"ruby"}
|
1693
1693
|
# load the gem
|
1694
1694
|
require 'purecloudplatformclientv2'
|
1695
1695
|
# setup authorization
|
@@ -1719,7 +1719,7 @@ begin
|
|
1719
1719
|
rescue PureCloud::ApiError => e
|
1720
1720
|
puts "Exception when calling AuthorizationApi->post_authorization_role_comparedefault_right_role_id: #{e}"
|
1721
1721
|
end
|
1722
|
-
|
1722
|
+
```
|
1723
1723
|
|
1724
1724
|
### Parameters
|
1725
1725
|
|
@@ -1744,7 +1744,7 @@ Name | Type | Description | Notes
|
|
1744
1744
|
|
1745
1745
|
<a name="post_authorization_roles"></a>
|
1746
1746
|
|
1747
|
-
##
|
1747
|
+
## [**DomainOrganizationRole**](DomainOrganizationRole.html) post_authorization_roles(body)
|
1748
1748
|
|
1749
1749
|
|
1750
1750
|
|
@@ -1760,7 +1760,7 @@ Requires ANY permissions:
|
|
1760
1760
|
|
1761
1761
|
|
1762
1762
|
### Example
|
1763
|
-
|
1763
|
+
```{"language":"ruby"}
|
1764
1764
|
# load the gem
|
1765
1765
|
require 'purecloudplatformclientv2'
|
1766
1766
|
# setup authorization
|
@@ -1786,7 +1786,7 @@ begin
|
|
1786
1786
|
rescue PureCloud::ApiError => e
|
1787
1787
|
puts "Exception when calling AuthorizationApi->post_authorization_roles: #{e}"
|
1788
1788
|
end
|
1789
|
-
|
1789
|
+
```
|
1790
1790
|
|
1791
1791
|
### Parameters
|
1792
1792
|
|
@@ -1809,7 +1809,7 @@ Name | Type | Description | Notes
|
|
1809
1809
|
|
1810
1810
|
<a name="post_authorization_roles_default"></a>
|
1811
1811
|
|
1812
|
-
##
|
1812
|
+
## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) post_authorization_roles_default(opts)
|
1813
1813
|
|
1814
1814
|
|
1815
1815
|
|
@@ -1825,7 +1825,7 @@ Requires ANY permissions:
|
|
1825
1825
|
|
1826
1826
|
|
1827
1827
|
### Example
|
1828
|
-
|
1828
|
+
```{"language":"ruby"}
|
1829
1829
|
# load the gem
|
1830
1830
|
require 'purecloudplatformclientv2'
|
1831
1831
|
# setup authorization
|
@@ -1852,7 +1852,7 @@ begin
|
|
1852
1852
|
rescue PureCloud::ApiError => e
|
1853
1853
|
puts "Exception when calling AuthorizationApi->post_authorization_roles_default: #{e}"
|
1854
1854
|
end
|
1855
|
-
|
1855
|
+
```
|
1856
1856
|
|
1857
1857
|
### Parameters
|
1858
1858
|
|
@@ -1875,7 +1875,7 @@ Name | Type | Description | Notes
|
|
1875
1875
|
|
1876
1876
|
<a name="post_authorization_subject_division_role"></a>
|
1877
1877
|
|
1878
|
-
##
|
1878
|
+
## post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
1879
1879
|
|
1880
1880
|
|
1881
1881
|
|
@@ -1891,7 +1891,7 @@ Requires ANY permissions:
|
|
1891
1891
|
|
1892
1892
|
|
1893
1893
|
### Example
|
1894
|
-
|
1894
|
+
```{"language":"ruby"}
|
1895
1895
|
# load the gem
|
1896
1896
|
require 'purecloudplatformclientv2'
|
1897
1897
|
# setup authorization
|
@@ -1923,7 +1923,7 @@ begin
|
|
1923
1923
|
rescue PureCloud::ApiError => e
|
1924
1924
|
puts "Exception when calling AuthorizationApi->post_authorization_subject_division_role: #{e}"
|
1925
1925
|
end
|
1926
|
-
|
1926
|
+
```
|
1927
1927
|
|
1928
1928
|
### Parameters
|
1929
1929
|
|
@@ -1949,7 +1949,7 @@ nil (empty response body)
|
|
1949
1949
|
|
1950
1950
|
<a name="put_authorization_division"></a>
|
1951
1951
|
|
1952
|
-
##
|
1952
|
+
## [**AuthzDivision**](AuthzDivision.html) put_authorization_division(division_id, body)
|
1953
1953
|
|
1954
1954
|
|
1955
1955
|
|
@@ -1965,7 +1965,7 @@ Requires ANY permissions:
|
|
1965
1965
|
|
1966
1966
|
|
1967
1967
|
### Example
|
1968
|
-
|
1968
|
+
```{"language":"ruby"}
|
1969
1969
|
# load the gem
|
1970
1970
|
require 'purecloudplatformclientv2'
|
1971
1971
|
# setup authorization
|
@@ -1993,7 +1993,7 @@ begin
|
|
1993
1993
|
rescue PureCloud::ApiError => e
|
1994
1994
|
puts "Exception when calling AuthorizationApi->put_authorization_division: #{e}"
|
1995
1995
|
end
|
1996
|
-
|
1996
|
+
```
|
1997
1997
|
|
1998
1998
|
### Parameters
|
1999
1999
|
|
@@ -2017,7 +2017,7 @@ Name | Type | Description | Notes
|
|
2017
2017
|
|
2018
2018
|
<a name="put_authorization_role"></a>
|
2019
2019
|
|
2020
|
-
##
|
2020
|
+
## [**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
|
2021
2021
|
|
2022
2022
|
|
2023
2023
|
|
@@ -2035,7 +2035,7 @@ Requires ANY permissions:
|
|
2035
2035
|
|
2036
2036
|
|
2037
2037
|
### Example
|
2038
|
-
|
2038
|
+
```{"language":"ruby"}
|
2039
2039
|
# load the gem
|
2040
2040
|
require 'purecloudplatformclientv2'
|
2041
2041
|
# setup authorization
|
@@ -2063,7 +2063,7 @@ begin
|
|
2063
2063
|
rescue PureCloud::ApiError => e
|
2064
2064
|
puts "Exception when calling AuthorizationApi->put_authorization_role: #{e}"
|
2065
2065
|
end
|
2066
|
-
|
2066
|
+
```
|
2067
2067
|
|
2068
2068
|
### Parameters
|
2069
2069
|
|
@@ -2087,7 +2087,7 @@ Name | Type | Description | Notes
|
|
2087
2087
|
|
2088
2088
|
<a name="put_authorization_role_users_add"></a>
|
2089
2089
|
|
2090
|
-
##
|
2090
|
+
## Array<String>** put_authorization_role_users_add(role_id, body)
|
2091
2091
|
|
2092
2092
|
|
2093
2093
|
|
@@ -2103,7 +2103,7 @@ Requires ANY permissions:
|
|
2103
2103
|
|
2104
2104
|
|
2105
2105
|
### Example
|
2106
|
-
|
2106
|
+
```{"language":"ruby"}
|
2107
2107
|
# load the gem
|
2108
2108
|
require 'purecloudplatformclientv2'
|
2109
2109
|
# setup authorization
|
@@ -2131,7 +2131,7 @@ begin
|
|
2131
2131
|
rescue PureCloud::ApiError => e
|
2132
2132
|
puts "Exception when calling AuthorizationApi->put_authorization_role_users_add: #{e}"
|
2133
2133
|
end
|
2134
|
-
|
2134
|
+
```
|
2135
2135
|
|
2136
2136
|
### Parameters
|
2137
2137
|
|
@@ -2155,7 +2155,7 @@ Name | Type | Description | Notes
|
|
2155
2155
|
|
2156
2156
|
<a name="put_authorization_role_users_remove"></a>
|
2157
2157
|
|
2158
|
-
##
|
2158
|
+
## Array<String>** put_authorization_role_users_remove(role_id, body)
|
2159
2159
|
|
2160
2160
|
|
2161
2161
|
|
@@ -2171,7 +2171,7 @@ Requires ANY permissions:
|
|
2171
2171
|
|
2172
2172
|
|
2173
2173
|
### Example
|
2174
|
-
|
2174
|
+
```{"language":"ruby"}
|
2175
2175
|
# load the gem
|
2176
2176
|
require 'purecloudplatformclientv2'
|
2177
2177
|
# setup authorization
|
@@ -2199,7 +2199,7 @@ begin
|
|
2199
2199
|
rescue PureCloud::ApiError => e
|
2200
2200
|
puts "Exception when calling AuthorizationApi->put_authorization_role_users_remove: #{e}"
|
2201
2201
|
end
|
2202
|
-
|
2202
|
+
```
|
2203
2203
|
|
2204
2204
|
### Parameters
|
2205
2205
|
|
@@ -2223,7 +2223,7 @@ Name | Type | Description | Notes
|
|
2223
2223
|
|
2224
2224
|
<a name="put_authorization_roles_default"></a>
|
2225
2225
|
|
2226
|
-
##
|
2226
|
+
## [**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) put_authorization_roles_default(body)
|
2227
2227
|
|
2228
2228
|
|
2229
2229
|
|
@@ -2239,7 +2239,7 @@ Requires ANY permissions:
|
|
2239
2239
|
|
2240
2240
|
|
2241
2241
|
### Example
|
2242
|
-
|
2242
|
+
```{"language":"ruby"}
|
2243
2243
|
# load the gem
|
2244
2244
|
require 'purecloudplatformclientv2'
|
2245
2245
|
# setup authorization
|
@@ -2265,7 +2265,7 @@ begin
|
|
2265
2265
|
rescue PureCloud::ApiError => e
|
2266
2266
|
puts "Exception when calling AuthorizationApi->put_authorization_roles_default: #{e}"
|
2267
2267
|
end
|
2268
|
-
|
2268
|
+
```
|
2269
2269
|
|
2270
2270
|
### Parameters
|
2271
2271
|
|
@@ -2288,7 +2288,7 @@ Name | Type | Description | Notes
|
|
2288
2288
|
|
2289
2289
|
<a name="put_user_roles"></a>
|
2290
2290
|
|
2291
|
-
##
|
2291
|
+
## [**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
|
2292
2292
|
|
2293
2293
|
|
2294
2294
|
|
@@ -2306,7 +2306,7 @@ Requires ANY permissions:
|
|
2306
2306
|
|
2307
2307
|
|
2308
2308
|
### Example
|
2309
|
-
|
2309
|
+
```{"language":"ruby"}
|
2310
2310
|
# load the gem
|
2311
2311
|
require 'purecloudplatformclientv2'
|
2312
2312
|
# setup authorization
|
@@ -2334,7 +2334,7 @@ begin
|
|
2334
2334
|
rescue PureCloud::ApiError => e
|
2335
2335
|
puts "Exception when calling AuthorizationApi->put_user_roles: #{e}"
|
2336
2336
|
end
|
2337
|
-
|
2337
|
+
```
|
2338
2338
|
|
2339
2339
|
### Parameters
|
2340
2340
|
|