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/ObjectsApi.md
CHANGED
@@ -20,7 +20,7 @@ Method | Description
|
|
20
20
|
|
21
21
|
<a name="delete_authorization_division"></a>
|
22
22
|
|
23
|
-
##
|
23
|
+
## delete_authorization_division(division_id)
|
24
24
|
|
25
25
|
|
26
26
|
|
@@ -36,7 +36,7 @@ Requires ANY permissions:
|
|
36
36
|
|
37
37
|
|
38
38
|
### Example
|
39
|
-
|
39
|
+
```{"language":"ruby"}
|
40
40
|
# load the gem
|
41
41
|
require 'purecloudplatformclientv2'
|
42
42
|
# setup authorization
|
@@ -61,7 +61,7 @@ begin
|
|
61
61
|
rescue PureCloud::ApiError => e
|
62
62
|
puts "Exception when calling ObjectsApi->delete_authorization_division: #{e}"
|
63
63
|
end
|
64
|
-
|
64
|
+
```
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
@@ -84,7 +84,7 @@ nil (empty response body)
|
|
84
84
|
|
85
85
|
<a name="get_authorization_division"></a>
|
86
86
|
|
87
|
-
##
|
87
|
+
## [**AuthzDivision**](AuthzDivision.html) get_authorization_division(division_id, opts)
|
88
88
|
|
89
89
|
|
90
90
|
|
@@ -99,7 +99,7 @@ Requires NO permissions:
|
|
99
99
|
|
100
100
|
|
101
101
|
### Example
|
102
|
-
|
102
|
+
```{"language":"ruby"}
|
103
103
|
# load the gem
|
104
104
|
require 'purecloudplatformclientv2'
|
105
105
|
# setup authorization
|
@@ -128,7 +128,7 @@ begin
|
|
128
128
|
rescue PureCloud::ApiError => e
|
129
129
|
puts "Exception when calling ObjectsApi->get_authorization_division: #{e}"
|
130
130
|
end
|
131
|
-
|
131
|
+
```
|
132
132
|
|
133
133
|
### Parameters
|
134
134
|
|
@@ -152,7 +152,7 @@ Name | Type | Description | Notes
|
|
152
152
|
|
153
153
|
<a name="get_authorization_divisions"></a>
|
154
154
|
|
155
|
-
##
|
155
|
+
## [**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html) get_authorization_divisions(opts)
|
156
156
|
|
157
157
|
|
158
158
|
|
@@ -167,7 +167,7 @@ Requires NO permissions:
|
|
167
167
|
|
168
168
|
|
169
169
|
### Example
|
170
|
-
|
170
|
+
```{"language":"ruby"}
|
171
171
|
# load the gem
|
172
172
|
require 'purecloudplatformclientv2'
|
173
173
|
# setup authorization
|
@@ -202,7 +202,7 @@ begin
|
|
202
202
|
rescue PureCloud::ApiError => e
|
203
203
|
puts "Exception when calling ObjectsApi->get_authorization_divisions: #{e}"
|
204
204
|
end
|
205
|
-
|
205
|
+
```
|
206
206
|
|
207
207
|
### Parameters
|
208
208
|
|
@@ -233,7 +233,7 @@ Name | Type | Description | Notes
|
|
233
233
|
|
234
234
|
<a name="get_authorization_divisions_home"></a>
|
235
235
|
|
236
|
-
##
|
236
|
+
## [**AuthzDivision**](AuthzDivision.html) get_authorization_divisions_home
|
237
237
|
|
238
238
|
|
239
239
|
|
@@ -248,7 +248,7 @@ Requires NO permissions:
|
|
248
248
|
|
249
249
|
|
250
250
|
### Example
|
251
|
-
|
251
|
+
```{"language":"ruby"}
|
252
252
|
# load the gem
|
253
253
|
require 'purecloudplatformclientv2'
|
254
254
|
# setup authorization
|
@@ -271,7 +271,7 @@ begin
|
|
271
271
|
rescue PureCloud::ApiError => e
|
272
272
|
puts "Exception when calling ObjectsApi->get_authorization_divisions_home: #{e}"
|
273
273
|
end
|
274
|
-
|
274
|
+
```
|
275
275
|
|
276
276
|
### Parameters
|
277
277
|
This endpoint does not need any parameter.
|
@@ -291,7 +291,7 @@ This endpoint does not need any parameter.
|
|
291
291
|
|
292
292
|
<a name="get_authorization_divisions_limit"></a>
|
293
293
|
|
294
|
-
##
|
294
|
+
## Integer** get_authorization_divisions_limit
|
295
295
|
|
296
296
|
|
297
297
|
|
@@ -306,7 +306,7 @@ Requires NO permissions:
|
|
306
306
|
|
307
307
|
|
308
308
|
### Example
|
309
|
-
|
309
|
+
```{"language":"ruby"}
|
310
310
|
# load the gem
|
311
311
|
require 'purecloudplatformclientv2'
|
312
312
|
# setup authorization
|
@@ -329,7 +329,7 @@ begin
|
|
329
329
|
rescue PureCloud::ApiError => e
|
330
330
|
puts "Exception when calling ObjectsApi->get_authorization_divisions_limit: #{e}"
|
331
331
|
end
|
332
|
-
|
332
|
+
```
|
333
333
|
|
334
334
|
### Parameters
|
335
335
|
This endpoint does not need any parameter.
|
@@ -349,7 +349,7 @@ This endpoint does not need any parameter.
|
|
349
349
|
|
350
350
|
<a name="post_authorization_division_object"></a>
|
351
351
|
|
352
|
-
##
|
352
|
+
## post_authorization_division_object(division_id, object_type, body)
|
353
353
|
|
354
354
|
|
355
355
|
|
@@ -364,7 +364,7 @@ Requires NO permissions:
|
|
364
364
|
|
365
365
|
|
366
366
|
### Example
|
367
|
-
|
367
|
+
```{"language":"ruby"}
|
368
368
|
# load the gem
|
369
369
|
require 'purecloudplatformclientv2'
|
370
370
|
# setup authorization
|
@@ -393,7 +393,7 @@ begin
|
|
393
393
|
rescue PureCloud::ApiError => e
|
394
394
|
puts "Exception when calling ObjectsApi->post_authorization_division_object: #{e}"
|
395
395
|
end
|
396
|
-
|
396
|
+
```
|
397
397
|
|
398
398
|
### Parameters
|
399
399
|
|
@@ -418,7 +418,7 @@ nil (empty response body)
|
|
418
418
|
|
419
419
|
<a name="post_authorization_divisions"></a>
|
420
420
|
|
421
|
-
##
|
421
|
+
## [**AuthzDivision**](AuthzDivision.html) post_authorization_divisions(body)
|
422
422
|
|
423
423
|
|
424
424
|
|
@@ -435,7 +435,7 @@ Requires ALL permissions:
|
|
435
435
|
|
436
436
|
|
437
437
|
### Example
|
438
|
-
|
438
|
+
```{"language":"ruby"}
|
439
439
|
# load the gem
|
440
440
|
require 'purecloudplatformclientv2'
|
441
441
|
# setup authorization
|
@@ -461,7 +461,7 @@ begin
|
|
461
461
|
rescue PureCloud::ApiError => e
|
462
462
|
puts "Exception when calling ObjectsApi->post_authorization_divisions: #{e}"
|
463
463
|
end
|
464
|
-
|
464
|
+
```
|
465
465
|
|
466
466
|
### Parameters
|
467
467
|
|
@@ -484,7 +484,7 @@ Name | Type | Description | Notes
|
|
484
484
|
|
485
485
|
<a name="put_authorization_division"></a>
|
486
486
|
|
487
|
-
##
|
487
|
+
## [**AuthzDivision**](AuthzDivision.html) put_authorization_division(division_id, body)
|
488
488
|
|
489
489
|
|
490
490
|
|
@@ -500,7 +500,7 @@ Requires ANY permissions:
|
|
500
500
|
|
501
501
|
|
502
502
|
### Example
|
503
|
-
|
503
|
+
```{"language":"ruby"}
|
504
504
|
# load the gem
|
505
505
|
require 'purecloudplatformclientv2'
|
506
506
|
# setup authorization
|
@@ -528,7 +528,7 @@ begin
|
|
528
528
|
rescue PureCloud::ApiError => e
|
529
529
|
puts "Exception when calling ObjectsApi->put_authorization_division: #{e}"
|
530
530
|
end
|
531
|
-
|
531
|
+
```
|
532
532
|
|
533
533
|
### Parameters
|
534
534
|
|
data/docs/OrganizationApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | Description
|
|
18
18
|
|
19
19
|
<a name="get_fieldconfig"></a>
|
20
20
|
|
21
|
-
##
|
21
|
+
## [**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
|
22
22
|
|
23
23
|
|
24
24
|
|
@@ -33,7 +33,7 @@ Requires NO permissions:
|
|
33
33
|
|
34
34
|
|
35
35
|
### Example
|
36
|
-
|
36
|
+
```{"language":"ruby"}
|
37
37
|
# load the gem
|
38
38
|
require 'purecloudplatformclientv2'
|
39
39
|
# setup authorization
|
@@ -59,7 +59,7 @@ begin
|
|
59
59
|
rescue PureCloud::ApiError => e
|
60
60
|
puts "Exception when calling OrganizationApi->get_fieldconfig: #{e}"
|
61
61
|
end
|
62
|
-
|
62
|
+
```
|
63
63
|
|
64
64
|
### Parameters
|
65
65
|
|
@@ -82,7 +82,7 @@ Name | Type | Description | Notes
|
|
82
82
|
|
83
83
|
<a name="get_organizations_me"></a>
|
84
84
|
|
85
|
-
##
|
85
|
+
## [**Organization**](Organization.html) get_organizations_me
|
86
86
|
|
87
87
|
|
88
88
|
|
@@ -97,7 +97,7 @@ Requires NO permissions:
|
|
97
97
|
|
98
98
|
|
99
99
|
### Example
|
100
|
-
|
100
|
+
```{"language":"ruby"}
|
101
101
|
# load the gem
|
102
102
|
require 'purecloudplatformclientv2'
|
103
103
|
# setup authorization
|
@@ -120,7 +120,7 @@ begin
|
|
120
120
|
rescue PureCloud::ApiError => e
|
121
121
|
puts "Exception when calling OrganizationApi->get_organizations_me: #{e}"
|
122
122
|
end
|
123
|
-
|
123
|
+
```
|
124
124
|
|
125
125
|
### Parameters
|
126
126
|
This endpoint does not need any parameter.
|
@@ -140,7 +140,7 @@ This endpoint does not need any parameter.
|
|
140
140
|
|
141
141
|
<a name="get_organizations_whitelist"></a>
|
142
142
|
|
143
|
-
##
|
143
|
+
## [**OrgWhitelistSettings**](OrgWhitelistSettings.html) get_organizations_whitelist
|
144
144
|
|
145
145
|
|
146
146
|
|
@@ -155,7 +155,7 @@ Requires NO permissions:
|
|
155
155
|
|
156
156
|
|
157
157
|
### Example
|
158
|
-
|
158
|
+
```{"language":"ruby"}
|
159
159
|
# load the gem
|
160
160
|
require 'purecloudplatformclientv2'
|
161
161
|
# setup authorization
|
@@ -178,7 +178,7 @@ begin
|
|
178
178
|
rescue PureCloud::ApiError => e
|
179
179
|
puts "Exception when calling OrganizationApi->get_organizations_whitelist: #{e}"
|
180
180
|
end
|
181
|
-
|
181
|
+
```
|
182
182
|
|
183
183
|
### Parameters
|
184
184
|
This endpoint does not need any parameter.
|
@@ -198,7 +198,7 @@ This endpoint does not need any parameter.
|
|
198
198
|
|
199
199
|
<a name="patch_organizations_feature"></a>
|
200
200
|
|
201
|
-
##
|
201
|
+
## [**OrganizationFeatures**](OrganizationFeatures.html) patch_organizations_feature(feature_name, enabled)
|
202
202
|
|
203
203
|
|
204
204
|
|
@@ -214,7 +214,7 @@ Requires ANY permissions:
|
|
214
214
|
|
215
215
|
|
216
216
|
### Example
|
217
|
-
|
217
|
+
```{"language":"ruby"}
|
218
218
|
# load the gem
|
219
219
|
require 'purecloudplatformclientv2'
|
220
220
|
# setup authorization
|
@@ -242,7 +242,7 @@ begin
|
|
242
242
|
rescue PureCloud::ApiError => e
|
243
243
|
puts "Exception when calling OrganizationApi->patch_organizations_feature: #{e}"
|
244
244
|
end
|
245
|
-
|
245
|
+
```
|
246
246
|
|
247
247
|
### Parameters
|
248
248
|
|
@@ -266,7 +266,7 @@ Name | Type | Description | Notes
|
|
266
266
|
|
267
267
|
<a name="put_organizations_me"></a>
|
268
268
|
|
269
|
-
##
|
269
|
+
## [**Organization**](Organization.html) put_organizations_me(opts)
|
270
270
|
|
271
271
|
|
272
272
|
|
@@ -282,7 +282,7 @@ Requires ANY permissions:
|
|
282
282
|
|
283
283
|
|
284
284
|
### Example
|
285
|
-
|
285
|
+
```{"language":"ruby"}
|
286
286
|
# load the gem
|
287
287
|
require 'purecloudplatformclientv2'
|
288
288
|
# setup authorization
|
@@ -309,7 +309,7 @@ begin
|
|
309
309
|
rescue PureCloud::ApiError => e
|
310
310
|
puts "Exception when calling OrganizationApi->put_organizations_me: #{e}"
|
311
311
|
end
|
312
|
-
|
312
|
+
```
|
313
313
|
|
314
314
|
### Parameters
|
315
315
|
|
@@ -332,7 +332,7 @@ Name | Type | Description | Notes
|
|
332
332
|
|
333
333
|
<a name="put_organizations_whitelist"></a>
|
334
334
|
|
335
|
-
##
|
335
|
+
## [**OrgWhitelistSettings**](OrgWhitelistSettings.html) put_organizations_whitelist(body)
|
336
336
|
|
337
337
|
|
338
338
|
|
@@ -348,7 +348,7 @@ Requires ANY permissions:
|
|
348
348
|
|
349
349
|
|
350
350
|
### Example
|
351
|
-
|
351
|
+
```{"language":"ruby"}
|
352
352
|
# load the gem
|
353
353
|
require 'purecloudplatformclientv2'
|
354
354
|
# setup authorization
|
@@ -374,7 +374,7 @@ begin
|
|
374
374
|
rescue PureCloud::ApiError => e
|
375
375
|
puts "Exception when calling OrganizationApi->put_organizations_whitelist: #{e}"
|
376
376
|
end
|
377
|
-
|
377
|
+
```
|
378
378
|
|
379
379
|
### Parameters
|
380
380
|
|
@@ -35,7 +35,7 @@ Method | Description
|
|
35
35
|
|
36
36
|
<a name="delete_orgauthorization_trustee"></a>
|
37
37
|
|
38
|
-
##
|
38
|
+
## delete_orgauthorization_trustee(trustee_org_id)
|
39
39
|
|
40
40
|
|
41
41
|
|
@@ -51,7 +51,7 @@ Requires ANY permissions:
|
|
51
51
|
|
52
52
|
|
53
53
|
### Example
|
54
|
-
|
54
|
+
```{"language":"ruby"}
|
55
55
|
# load the gem
|
56
56
|
require 'purecloudplatformclientv2'
|
57
57
|
# setup authorization
|
@@ -76,7 +76,7 @@ begin
|
|
76
76
|
rescue PureCloud::ApiError => e
|
77
77
|
puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee: #{e}"
|
78
78
|
end
|
79
|
-
|
79
|
+
```
|
80
80
|
|
81
81
|
### Parameters
|
82
82
|
|
@@ -99,7 +99,7 @@ nil (empty response body)
|
|
99
99
|
|
100
100
|
<a name="delete_orgauthorization_trustee_user"></a>
|
101
101
|
|
102
|
-
##
|
102
|
+
## delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
|
103
103
|
|
104
104
|
|
105
105
|
|
@@ -117,7 +117,7 @@ Requires ANY permissions:
|
|
117
117
|
|
118
118
|
|
119
119
|
### Example
|
120
|
-
|
120
|
+
```{"language":"ruby"}
|
121
121
|
# load the gem
|
122
122
|
require 'purecloudplatformclientv2'
|
123
123
|
# setup authorization
|
@@ -144,7 +144,7 @@ begin
|
|
144
144
|
rescue PureCloud::ApiError => e
|
145
145
|
puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user: #{e}"
|
146
146
|
end
|
147
|
-
|
147
|
+
```
|
148
148
|
|
149
149
|
### Parameters
|
150
150
|
|
@@ -168,7 +168,7 @@ nil (empty response body)
|
|
168
168
|
|
169
169
|
<a name="delete_orgauthorization_trustee_user_roles"></a>
|
170
170
|
|
171
|
-
##
|
171
|
+
## delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
|
172
172
|
|
173
173
|
|
174
174
|
|
@@ -186,7 +186,7 @@ Requires ANY permissions:
|
|
186
186
|
|
187
187
|
|
188
188
|
### Example
|
189
|
-
|
189
|
+
```{"language":"ruby"}
|
190
190
|
# load the gem
|
191
191
|
require 'purecloudplatformclientv2'
|
192
192
|
# setup authorization
|
@@ -213,7 +213,7 @@ begin
|
|
213
213
|
rescue PureCloud::ApiError => e
|
214
214
|
puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user_roles: #{e}"
|
215
215
|
end
|
216
|
-
|
216
|
+
```
|
217
217
|
|
218
218
|
### Parameters
|
219
219
|
|
@@ -237,7 +237,7 @@ nil (empty response body)
|
|
237
237
|
|
238
238
|
<a name="delete_orgauthorization_trustor"></a>
|
239
239
|
|
240
|
-
##
|
240
|
+
## delete_orgauthorization_trustor(trustor_org_id)
|
241
241
|
|
242
242
|
|
243
243
|
|
@@ -253,7 +253,7 @@ Requires ANY permissions:
|
|
253
253
|
|
254
254
|
|
255
255
|
### Example
|
256
|
-
|
256
|
+
```{"language":"ruby"}
|
257
257
|
# load the gem
|
258
258
|
require 'purecloudplatformclientv2'
|
259
259
|
# setup authorization
|
@@ -278,7 +278,7 @@ begin
|
|
278
278
|
rescue PureCloud::ApiError => e
|
279
279
|
puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor: #{e}"
|
280
280
|
end
|
281
|
-
|
281
|
+
```
|
282
282
|
|
283
283
|
### Parameters
|
284
284
|
|
@@ -301,7 +301,7 @@ nil (empty response body)
|
|
301
301
|
|
302
302
|
<a name="delete_orgauthorization_trustor_user"></a>
|
303
303
|
|
304
|
-
##
|
304
|
+
## delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
|
305
305
|
|
306
306
|
|
307
307
|
|
@@ -317,7 +317,7 @@ Requires ANY permissions:
|
|
317
317
|
|
318
318
|
|
319
319
|
### Example
|
320
|
-
|
320
|
+
```{"language":"ruby"}
|
321
321
|
# load the gem
|
322
322
|
require 'purecloudplatformclientv2'
|
323
323
|
# setup authorization
|
@@ -344,7 +344,7 @@ begin
|
|
344
344
|
rescue PureCloud::ApiError => e
|
345
345
|
puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor_user: #{e}"
|
346
346
|
end
|
347
|
-
|
347
|
+
```
|
348
348
|
|
349
349
|
### Parameters
|
350
350
|
|
@@ -368,7 +368,7 @@ nil (empty response body)
|
|
368
368
|
|
369
369
|
<a name="get_orgauthorization_pairing"></a>
|
370
370
|
|
371
|
-
##
|
371
|
+
## [**TrustRequest**](TrustRequest.html) get_orgauthorization_pairing(pairing_id)
|
372
372
|
|
373
373
|
|
374
374
|
|
@@ -385,7 +385,7 @@ Requires ANY permissions:
|
|
385
385
|
|
386
386
|
|
387
387
|
### Example
|
388
|
-
|
388
|
+
```{"language":"ruby"}
|
389
389
|
# load the gem
|
390
390
|
require 'purecloudplatformclientv2'
|
391
391
|
# setup authorization
|
@@ -411,7 +411,7 @@ begin
|
|
411
411
|
rescue PureCloud::ApiError => e
|
412
412
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_pairing: #{e}"
|
413
413
|
end
|
414
|
-
|
414
|
+
```
|
415
415
|
|
416
416
|
### Parameters
|
417
417
|
|
@@ -434,7 +434,7 @@ Name | Type | Description | Notes
|
|
434
434
|
|
435
435
|
<a name="get_orgauthorization_trustee"></a>
|
436
436
|
|
437
|
-
##
|
437
|
+
## [**Trustee**](Trustee.html) get_orgauthorization_trustee(trustee_org_id)
|
438
438
|
|
439
439
|
|
440
440
|
|
@@ -450,7 +450,7 @@ Requires ANY permissions:
|
|
450
450
|
|
451
451
|
|
452
452
|
### Example
|
453
|
-
|
453
|
+
```{"language":"ruby"}
|
454
454
|
# load the gem
|
455
455
|
require 'purecloudplatformclientv2'
|
456
456
|
# setup authorization
|
@@ -476,7 +476,7 @@ begin
|
|
476
476
|
rescue PureCloud::ApiError => e
|
477
477
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee: #{e}"
|
478
478
|
end
|
479
|
-
|
479
|
+
```
|
480
480
|
|
481
481
|
### Parameters
|
482
482
|
|
@@ -499,7 +499,7 @@ Name | Type | Description | Notes
|
|
499
499
|
|
500
500
|
<a name="get_orgauthorization_trustee_user"></a>
|
501
501
|
|
502
|
-
##
|
502
|
+
## [**TrustUser**](TrustUser.html) get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
|
503
503
|
|
504
504
|
|
505
505
|
|
@@ -515,7 +515,7 @@ Requires ANY permissions:
|
|
515
515
|
|
516
516
|
|
517
517
|
### Example
|
518
|
-
|
518
|
+
```{"language":"ruby"}
|
519
519
|
# load the gem
|
520
520
|
require 'purecloudplatformclientv2'
|
521
521
|
# setup authorization
|
@@ -543,7 +543,7 @@ begin
|
|
543
543
|
rescue PureCloud::ApiError => e
|
544
544
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user: #{e}"
|
545
545
|
end
|
546
|
-
|
546
|
+
```
|
547
547
|
|
548
548
|
### Parameters
|
549
549
|
|
@@ -567,7 +567,7 @@ Name | Type | Description | Notes
|
|
567
567
|
|
568
568
|
<a name="get_orgauthorization_trustee_user_roles"></a>
|
569
569
|
|
570
|
-
##
|
570
|
+
## [**UserAuthorization**](UserAuthorization.html) get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
|
571
571
|
|
572
572
|
|
573
573
|
|
@@ -583,7 +583,7 @@ Requires ANY permissions:
|
|
583
583
|
|
584
584
|
|
585
585
|
### Example
|
586
|
-
|
586
|
+
```{"language":"ruby"}
|
587
587
|
# load the gem
|
588
588
|
require 'purecloudplatformclientv2'
|
589
589
|
# setup authorization
|
@@ -611,7 +611,7 @@ begin
|
|
611
611
|
rescue PureCloud::ApiError => e
|
612
612
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user_roles: #{e}"
|
613
613
|
end
|
614
|
-
|
614
|
+
```
|
615
615
|
|
616
616
|
### Parameters
|
617
617
|
|
@@ -635,7 +635,7 @@ Name | Type | Description | Notes
|
|
635
635
|
|
636
636
|
<a name="get_orgauthorization_trustee_users"></a>
|
637
637
|
|
638
|
-
##
|
638
|
+
## [**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustee_users(trustee_org_id, opts)
|
639
639
|
|
640
640
|
|
641
641
|
|
@@ -651,7 +651,7 @@ Requires ANY permissions:
|
|
651
651
|
|
652
652
|
|
653
653
|
### Example
|
654
|
-
|
654
|
+
```{"language":"ruby"}
|
655
655
|
# load the gem
|
656
656
|
require 'purecloudplatformclientv2'
|
657
657
|
# setup authorization
|
@@ -681,7 +681,7 @@ begin
|
|
681
681
|
rescue PureCloud::ApiError => e
|
682
682
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_users: #{e}"
|
683
683
|
end
|
684
|
-
|
684
|
+
```
|
685
685
|
|
686
686
|
### Parameters
|
687
687
|
|
@@ -706,7 +706,7 @@ Name | Type | Description | Notes
|
|
706
706
|
|
707
707
|
<a name="get_orgauthorization_trustees"></a>
|
708
708
|
|
709
|
-
##
|
709
|
+
## [**TrustEntityListing**](TrustEntityListing.html) get_orgauthorization_trustees(opts)
|
710
710
|
|
711
711
|
|
712
712
|
|
@@ -722,7 +722,7 @@ Requires ANY permissions:
|
|
722
722
|
|
723
723
|
|
724
724
|
### Example
|
725
|
-
|
725
|
+
```{"language":"ruby"}
|
726
726
|
# load the gem
|
727
727
|
require 'purecloudplatformclientv2'
|
728
728
|
# setup authorization
|
@@ -750,7 +750,7 @@ begin
|
|
750
750
|
rescue PureCloud::ApiError => e
|
751
751
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustees: #{e}"
|
752
752
|
end
|
753
|
-
|
753
|
+
```
|
754
754
|
|
755
755
|
### Parameters
|
756
756
|
|
@@ -774,7 +774,7 @@ Name | Type | Description | Notes
|
|
774
774
|
|
775
775
|
<a name="get_orgauthorization_trustor"></a>
|
776
776
|
|
777
|
-
##
|
777
|
+
## [**Trustor**](Trustor.html) get_orgauthorization_trustor(trustor_org_id)
|
778
778
|
|
779
779
|
|
780
780
|
|
@@ -790,7 +790,7 @@ Requires ANY permissions:
|
|
790
790
|
|
791
791
|
|
792
792
|
### Example
|
793
|
-
|
793
|
+
```{"language":"ruby"}
|
794
794
|
# load the gem
|
795
795
|
require 'purecloudplatformclientv2'
|
796
796
|
# setup authorization
|
@@ -816,7 +816,7 @@ begin
|
|
816
816
|
rescue PureCloud::ApiError => e
|
817
817
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor: #{e}"
|
818
818
|
end
|
819
|
-
|
819
|
+
```
|
820
820
|
|
821
821
|
### Parameters
|
822
822
|
|
@@ -839,7 +839,7 @@ Name | Type | Description | Notes
|
|
839
839
|
|
840
840
|
<a name="get_orgauthorization_trustor_user"></a>
|
841
841
|
|
842
|
-
##
|
842
|
+
## [**TrustUser**](TrustUser.html) get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
|
843
843
|
|
844
844
|
|
845
845
|
|
@@ -855,7 +855,7 @@ Requires ANY permissions:
|
|
855
855
|
|
856
856
|
|
857
857
|
### Example
|
858
|
-
|
858
|
+
```{"language":"ruby"}
|
859
859
|
# load the gem
|
860
860
|
require 'purecloudplatformclientv2'
|
861
861
|
# setup authorization
|
@@ -883,7 +883,7 @@ begin
|
|
883
883
|
rescue PureCloud::ApiError => e
|
884
884
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_user: #{e}"
|
885
885
|
end
|
886
|
-
|
886
|
+
```
|
887
887
|
|
888
888
|
### Parameters
|
889
889
|
|
@@ -907,7 +907,7 @@ Name | Type | Description | Notes
|
|
907
907
|
|
908
908
|
<a name="get_orgauthorization_trustor_users"></a>
|
909
909
|
|
910
|
-
##
|
910
|
+
## [**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustor_users(trustor_org_id, opts)
|
911
911
|
|
912
912
|
|
913
913
|
|
@@ -923,7 +923,7 @@ Requires ANY permissions:
|
|
923
923
|
|
924
924
|
|
925
925
|
### Example
|
926
|
-
|
926
|
+
```{"language":"ruby"}
|
927
927
|
# load the gem
|
928
928
|
require 'purecloudplatformclientv2'
|
929
929
|
# setup authorization
|
@@ -953,7 +953,7 @@ begin
|
|
953
953
|
rescue PureCloud::ApiError => e
|
954
954
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_users: #{e}"
|
955
955
|
end
|
956
|
-
|
956
|
+
```
|
957
957
|
|
958
958
|
### Parameters
|
959
959
|
|
@@ -978,7 +978,7 @@ Name | Type | Description | Notes
|
|
978
978
|
|
979
979
|
<a name="get_orgauthorization_trustors"></a>
|
980
980
|
|
981
|
-
##
|
981
|
+
## [**TrustorEntityListing**](TrustorEntityListing.html) get_orgauthorization_trustors(opts)
|
982
982
|
|
983
983
|
|
984
984
|
|
@@ -994,7 +994,7 @@ Requires ANY permissions:
|
|
994
994
|
|
995
995
|
|
996
996
|
### Example
|
997
|
-
|
997
|
+
```{"language":"ruby"}
|
998
998
|
# load the gem
|
999
999
|
require 'purecloudplatformclientv2'
|
1000
1000
|
# setup authorization
|
@@ -1022,7 +1022,7 @@ begin
|
|
1022
1022
|
rescue PureCloud::ApiError => e
|
1023
1023
|
puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustors: #{e}"
|
1024
1024
|
end
|
1025
|
-
|
1025
|
+
```
|
1026
1026
|
|
1027
1027
|
### Parameters
|
1028
1028
|
|
@@ -1046,7 +1046,7 @@ Name | Type | Description | Notes
|
|
1046
1046
|
|
1047
1047
|
<a name="post_orgauthorization_pairings"></a>
|
1048
1048
|
|
1049
|
-
##
|
1049
|
+
## [**TrustRequest**](TrustRequest.html) post_orgauthorization_pairings(body)
|
1050
1050
|
|
1051
1051
|
|
1052
1052
|
|
@@ -1062,7 +1062,7 @@ Requires ANY permissions:
|
|
1062
1062
|
|
1063
1063
|
|
1064
1064
|
### Example
|
1065
|
-
|
1065
|
+
```{"language":"ruby"}
|
1066
1066
|
# load the gem
|
1067
1067
|
require 'purecloudplatformclientv2'
|
1068
1068
|
# setup authorization
|
@@ -1088,7 +1088,7 @@ begin
|
|
1088
1088
|
rescue PureCloud::ApiError => e
|
1089
1089
|
puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_pairings: #{e}"
|
1090
1090
|
end
|
1091
|
-
|
1091
|
+
```
|
1092
1092
|
|
1093
1093
|
### Parameters
|
1094
1094
|
|
@@ -1111,7 +1111,7 @@ Name | Type | Description | Notes
|
|
1111
1111
|
|
1112
1112
|
<a name="post_orgauthorization_trustee_users"></a>
|
1113
1113
|
|
1114
|
-
##
|
1114
|
+
## [**TrustUser**](TrustUser.html) post_orgauthorization_trustee_users(trustee_org_id, body)
|
1115
1115
|
|
1116
1116
|
|
1117
1117
|
|
@@ -1129,7 +1129,7 @@ Requires ALL permissions:
|
|
1129
1129
|
|
1130
1130
|
|
1131
1131
|
### Example
|
1132
|
-
|
1132
|
+
```{"language":"ruby"}
|
1133
1133
|
# load the gem
|
1134
1134
|
require 'purecloudplatformclientv2'
|
1135
1135
|
# setup authorization
|
@@ -1157,7 +1157,7 @@ begin
|
|
1157
1157
|
rescue PureCloud::ApiError => e
|
1158
1158
|
puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustee_users: #{e}"
|
1159
1159
|
end
|
1160
|
-
|
1160
|
+
```
|
1161
1161
|
|
1162
1162
|
### Parameters
|
1163
1163
|
|
@@ -1181,7 +1181,7 @@ Name | Type | Description | Notes
|
|
1181
1181
|
|
1182
1182
|
<a name="post_orgauthorization_trustees"></a>
|
1183
1183
|
|
1184
|
-
##
|
1184
|
+
## [**Trustee**](Trustee.html) post_orgauthorization_trustees(body)
|
1185
1185
|
|
1186
1186
|
|
1187
1187
|
|
@@ -1198,7 +1198,7 @@ Requires ALL permissions:
|
|
1198
1198
|
|
1199
1199
|
|
1200
1200
|
### Example
|
1201
|
-
|
1201
|
+
```{"language":"ruby"}
|
1202
1202
|
# load the gem
|
1203
1203
|
require 'purecloudplatformclientv2'
|
1204
1204
|
# setup authorization
|
@@ -1224,7 +1224,7 @@ begin
|
|
1224
1224
|
rescue PureCloud::ApiError => e
|
1225
1225
|
puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees: #{e}"
|
1226
1226
|
end
|
1227
|
-
|
1227
|
+
```
|
1228
1228
|
|
1229
1229
|
### Parameters
|
1230
1230
|
|
@@ -1247,7 +1247,7 @@ Name | Type | Description | Notes
|
|
1247
1247
|
|
1248
1248
|
<a name="post_orgauthorization_trustees_audits"></a>
|
1249
1249
|
|
1250
|
-
##
|
1250
|
+
## [**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustees_audits(body, opts)
|
1251
1251
|
|
1252
1252
|
|
1253
1253
|
|
@@ -1263,7 +1263,7 @@ Requires ANY permissions:
|
|
1263
1263
|
|
1264
1264
|
|
1265
1265
|
### Example
|
1266
|
-
|
1266
|
+
```{"language":"ruby"}
|
1267
1267
|
# load the gem
|
1268
1268
|
require 'purecloudplatformclientv2'
|
1269
1269
|
# setup authorization
|
@@ -1295,7 +1295,7 @@ begin
|
|
1295
1295
|
rescue PureCloud::ApiError => e
|
1296
1296
|
puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees_audits: #{e}"
|
1297
1297
|
end
|
1298
|
-
|
1298
|
+
```
|
1299
1299
|
|
1300
1300
|
### Parameters
|
1301
1301
|
|
@@ -1322,7 +1322,7 @@ Name | Type | Description | Notes
|
|
1322
1322
|
|
1323
1323
|
<a name="post_orgauthorization_trustor_audits"></a>
|
1324
1324
|
|
1325
|
-
##
|
1325
|
+
## [**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustor_audits(body, opts)
|
1326
1326
|
|
1327
1327
|
|
1328
1328
|
|
@@ -1338,7 +1338,7 @@ Requires ANY permissions:
|
|
1338
1338
|
|
1339
1339
|
|
1340
1340
|
### Example
|
1341
|
-
|
1341
|
+
```{"language":"ruby"}
|
1342
1342
|
# load the gem
|
1343
1343
|
require 'purecloudplatformclientv2'
|
1344
1344
|
# setup authorization
|
@@ -1370,7 +1370,7 @@ begin
|
|
1370
1370
|
rescue PureCloud::ApiError => e
|
1371
1371
|
puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustor_audits: #{e}"
|
1372
1372
|
end
|
1373
|
-
|
1373
|
+
```
|
1374
1374
|
|
1375
1375
|
### Parameters
|
1376
1376
|
|
@@ -1397,7 +1397,7 @@ Name | Type | Description | Notes
|
|
1397
1397
|
|
1398
1398
|
<a name="put_orgauthorization_trustee"></a>
|
1399
1399
|
|
1400
|
-
##
|
1400
|
+
## [**Trustee**](Trustee.html) put_orgauthorization_trustee(trustee_org_id, body)
|
1401
1401
|
|
1402
1402
|
|
1403
1403
|
|
@@ -1413,7 +1413,7 @@ Requires ANY permissions:
|
|
1413
1413
|
|
1414
1414
|
|
1415
1415
|
### Example
|
1416
|
-
|
1416
|
+
```{"language":"ruby"}
|
1417
1417
|
# load the gem
|
1418
1418
|
require 'purecloudplatformclientv2'
|
1419
1419
|
# setup authorization
|
@@ -1441,7 +1441,7 @@ begin
|
|
1441
1441
|
rescue PureCloud::ApiError => e
|
1442
1442
|
puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee: #{e}"
|
1443
1443
|
end
|
1444
|
-
|
1444
|
+
```
|
1445
1445
|
|
1446
1446
|
### Parameters
|
1447
1447
|
|
@@ -1465,7 +1465,7 @@ Name | Type | Description | Notes
|
|
1465
1465
|
|
1466
1466
|
<a name="put_orgauthorization_trustee_user_roles"></a>
|
1467
1467
|
|
1468
|
-
##
|
1468
|
+
## [**UserAuthorization**](UserAuthorization.html) put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body)
|
1469
1469
|
|
1470
1470
|
|
1471
1471
|
|
@@ -1483,7 +1483,7 @@ Requires ANY permissions:
|
|
1483
1483
|
|
1484
1484
|
|
1485
1485
|
### Example
|
1486
|
-
|
1486
|
+
```{"language":"ruby"}
|
1487
1487
|
# load the gem
|
1488
1488
|
require 'purecloudplatformclientv2'
|
1489
1489
|
# setup authorization
|
@@ -1513,7 +1513,7 @@ begin
|
|
1513
1513
|
rescue PureCloud::ApiError => e
|
1514
1514
|
puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_user_roles: #{e}"
|
1515
1515
|
end
|
1516
|
-
|
1516
|
+
```
|
1517
1517
|
|
1518
1518
|
### Parameters
|
1519
1519
|
|
@@ -1538,7 +1538,7 @@ Name | Type | Description | Notes
|
|
1538
1538
|
|
1539
1539
|
<a name="put_orgauthorization_trustor_user"></a>
|
1540
1540
|
|
1541
|
-
##
|
1541
|
+
## [**TrustUser**](TrustUser.html) put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
|
1542
1542
|
|
1543
1543
|
|
1544
1544
|
|
@@ -1554,7 +1554,7 @@ Requires ALL permissions:
|
|
1554
1554
|
|
1555
1555
|
|
1556
1556
|
### Example
|
1557
|
-
|
1557
|
+
```{"language":"ruby"}
|
1558
1558
|
# load the gem
|
1559
1559
|
require 'purecloudplatformclientv2'
|
1560
1560
|
# setup authorization
|
@@ -1582,7 +1582,7 @@ begin
|
|
1582
1582
|
rescue PureCloud::ApiError => e
|
1583
1583
|
puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustor_user: #{e}"
|
1584
1584
|
end
|
1585
|
-
|
1585
|
+
```
|
1586
1586
|
|
1587
1587
|
### Parameters
|
1588
1588
|
|