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/UtilitiesApi.md
CHANGED
@@ -16,7 +16,7 @@ Method | Description
|
|
16
16
|
|
17
17
|
<a name="get_date"></a>
|
18
18
|
|
19
|
-
##
|
19
|
+
## [**ServerDate**](ServerDate.html) get_date
|
20
20
|
|
21
21
|
|
22
22
|
|
@@ -31,7 +31,7 @@ Requires NO permissions:
|
|
31
31
|
|
32
32
|
|
33
33
|
### Example
|
34
|
-
|
34
|
+
```{"language":"ruby"}
|
35
35
|
# load the gem
|
36
36
|
require 'purecloudplatformclientv2'
|
37
37
|
# setup authorization
|
@@ -54,7 +54,7 @@ begin
|
|
54
54
|
rescue PureCloud::ApiError => e
|
55
55
|
puts "Exception when calling UtilitiesApi->get_date: #{e}"
|
56
56
|
end
|
57
|
-
|
57
|
+
```
|
58
58
|
|
59
59
|
### Parameters
|
60
60
|
This endpoint does not need any parameter.
|
@@ -74,7 +74,7 @@ This endpoint does not need any parameter.
|
|
74
74
|
|
75
75
|
<a name="get_timezones"></a>
|
76
76
|
|
77
|
-
##
|
77
|
+
## [**TimeZoneEntityListing**](TimeZoneEntityListing.html) get_timezones(opts)
|
78
78
|
|
79
79
|
|
80
80
|
|
@@ -89,7 +89,7 @@ Requires NO permissions:
|
|
89
89
|
|
90
90
|
|
91
91
|
### Example
|
92
|
-
|
92
|
+
```{"language":"ruby"}
|
93
93
|
# load the gem
|
94
94
|
require 'purecloudplatformclientv2'
|
95
95
|
# setup authorization
|
@@ -117,7 +117,7 @@ begin
|
|
117
117
|
rescue PureCloud::ApiError => e
|
118
118
|
puts "Exception when calling UtilitiesApi->get_timezones: #{e}"
|
119
119
|
end
|
120
|
-
|
120
|
+
```
|
121
121
|
|
122
122
|
### Parameters
|
123
123
|
|
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
|
|
141
141
|
|
142
142
|
<a name="post_certificate_details"></a>
|
143
143
|
|
144
|
-
##
|
144
|
+
## [**ParsedCertificate**](ParsedCertificate.html) post_certificate_details(body)
|
145
145
|
|
146
146
|
|
147
147
|
|
@@ -156,7 +156,7 @@ Requires NO permissions:
|
|
156
156
|
|
157
157
|
|
158
158
|
### Example
|
159
|
-
|
159
|
+
```{"language":"ruby"}
|
160
160
|
# load the gem
|
161
161
|
require 'purecloudplatformclientv2'
|
162
162
|
# setup authorization
|
@@ -182,7 +182,7 @@ begin
|
|
182
182
|
rescue PureCloud::ApiError => e
|
183
183
|
puts "Exception when calling UtilitiesApi->post_certificate_details: #{e}"
|
184
184
|
end
|
185
|
-
|
185
|
+
```
|
186
186
|
|
187
187
|
### Parameters
|
188
188
|
|
@@ -205,7 +205,7 @@ Name | Type | Description | Notes
|
|
205
205
|
|
206
206
|
<a name="post_gmsc_tokens"></a>
|
207
207
|
|
208
|
-
##
|
208
|
+
## [**Token**](Token.html) post_gmsc_tokens
|
209
209
|
|
210
210
|
|
211
211
|
|
@@ -220,7 +220,7 @@ Requires NO permissions:
|
|
220
220
|
|
221
221
|
|
222
222
|
### Example
|
223
|
-
|
223
|
+
```{"language":"ruby"}
|
224
224
|
# load the gem
|
225
225
|
require 'purecloudplatformclientv2'
|
226
226
|
# setup authorization
|
@@ -243,7 +243,7 @@ begin
|
|
243
243
|
rescue PureCloud::ApiError => e
|
244
244
|
puts "Exception when calling UtilitiesApi->post_gmsc_tokens: #{e}"
|
245
245
|
end
|
246
|
-
|
246
|
+
```
|
247
247
|
|
248
248
|
### Parameters
|
249
249
|
This endpoint does not need any parameter.
|
data/docs/VoicemailApi.md
CHANGED
@@ -36,7 +36,7 @@ Method | Description
|
|
36
36
|
|
37
37
|
<a name="delete_voicemail_message"></a>
|
38
38
|
|
39
|
-
##
|
39
|
+
## delete_voicemail_message(message_id)
|
40
40
|
|
41
41
|
|
42
42
|
|
@@ -51,7 +51,7 @@ Requires NO 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 VoicemailApi->delete_voicemail_message: #{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_voicemail_messages"></a>
|
101
101
|
|
102
|
-
##
|
102
|
+
## delete_voicemail_messages
|
103
103
|
|
104
104
|
|
105
105
|
|
@@ -114,7 +114,7 @@ Requires NO permissions:
|
|
114
114
|
|
115
115
|
|
116
116
|
### Example
|
117
|
-
|
117
|
+
```{"language":"ruby"}
|
118
118
|
# load the gem
|
119
119
|
require 'purecloudplatformclientv2'
|
120
120
|
# setup authorization
|
@@ -136,7 +136,7 @@ begin
|
|
136
136
|
rescue PureCloud::ApiError => e
|
137
137
|
puts "Exception when calling VoicemailApi->delete_voicemail_messages: #{e}"
|
138
138
|
end
|
139
|
-
|
139
|
+
```
|
140
140
|
|
141
141
|
### Parameters
|
142
142
|
This endpoint does not need any parameter.
|
@@ -156,7 +156,7 @@ nil (empty response body)
|
|
156
156
|
|
157
157
|
<a name="get_voicemail_group_mailbox"></a>
|
158
158
|
|
159
|
-
##
|
159
|
+
## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_group_mailbox(group_id)
|
160
160
|
|
161
161
|
|
162
162
|
|
@@ -171,7 +171,7 @@ Requires NO permissions:
|
|
171
171
|
|
172
172
|
|
173
173
|
### Example
|
174
|
-
|
174
|
+
```{"language":"ruby"}
|
175
175
|
# load the gem
|
176
176
|
require 'purecloudplatformclientv2'
|
177
177
|
# setup authorization
|
@@ -197,7 +197,7 @@ begin
|
|
197
197
|
rescue PureCloud::ApiError => e
|
198
198
|
puts "Exception when calling VoicemailApi->get_voicemail_group_mailbox: #{e}"
|
199
199
|
end
|
200
|
-
|
200
|
+
```
|
201
201
|
|
202
202
|
### Parameters
|
203
203
|
|
@@ -220,7 +220,7 @@ Name | Type | Description | Notes
|
|
220
220
|
|
221
221
|
<a name="get_voicemail_group_messages"></a>
|
222
222
|
|
223
|
-
##
|
223
|
+
## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_group_messages(group_id, opts)
|
224
224
|
|
225
225
|
|
226
226
|
|
@@ -235,7 +235,7 @@ Requires NO permissions:
|
|
235
235
|
|
236
236
|
|
237
237
|
### Example
|
238
|
-
|
238
|
+
```{"language":"ruby"}
|
239
239
|
# load the gem
|
240
240
|
require 'purecloudplatformclientv2'
|
241
241
|
# setup authorization
|
@@ -265,7 +265,7 @@ begin
|
|
265
265
|
rescue PureCloud::ApiError => e
|
266
266
|
puts "Exception when calling VoicemailApi->get_voicemail_group_messages: #{e}"
|
267
267
|
end
|
268
|
-
|
268
|
+
```
|
269
269
|
|
270
270
|
### Parameters
|
271
271
|
|
@@ -290,7 +290,7 @@ Name | Type | Description | Notes
|
|
290
290
|
|
291
291
|
<a name="get_voicemail_group_policy"></a>
|
292
292
|
|
293
|
-
##
|
293
|
+
## [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) get_voicemail_group_policy(group_id)
|
294
294
|
|
295
295
|
|
296
296
|
|
@@ -309,7 +309,7 @@ Requires ANY permissions:
|
|
309
309
|
|
310
310
|
|
311
311
|
### Example
|
312
|
-
|
312
|
+
```{"language":"ruby"}
|
313
313
|
# load the gem
|
314
314
|
require 'purecloudplatformclientv2'
|
315
315
|
# setup authorization
|
@@ -335,7 +335,7 @@ begin
|
|
335
335
|
rescue PureCloud::ApiError => e
|
336
336
|
puts "Exception when calling VoicemailApi->get_voicemail_group_policy: #{e}"
|
337
337
|
end
|
338
|
-
|
338
|
+
```
|
339
339
|
|
340
340
|
### Parameters
|
341
341
|
|
@@ -358,7 +358,7 @@ Name | Type | Description | Notes
|
|
358
358
|
|
359
359
|
<a name="get_voicemail_mailbox"></a>
|
360
360
|
|
361
|
-
##
|
361
|
+
## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_mailbox
|
362
362
|
|
363
363
|
|
364
364
|
|
@@ -373,7 +373,7 @@ Requires NO permissions:
|
|
373
373
|
|
374
374
|
|
375
375
|
### Example
|
376
|
-
|
376
|
+
```{"language":"ruby"}
|
377
377
|
# load the gem
|
378
378
|
require 'purecloudplatformclientv2'
|
379
379
|
# setup authorization
|
@@ -396,7 +396,7 @@ begin
|
|
396
396
|
rescue PureCloud::ApiError => e
|
397
397
|
puts "Exception when calling VoicemailApi->get_voicemail_mailbox: #{e}"
|
398
398
|
end
|
399
|
-
|
399
|
+
```
|
400
400
|
|
401
401
|
### Parameters
|
402
402
|
This endpoint does not need any parameter.
|
@@ -416,7 +416,7 @@ This endpoint does not need any parameter.
|
|
416
416
|
|
417
417
|
<a name="get_voicemail_me_mailbox"></a>
|
418
418
|
|
419
|
-
##
|
419
|
+
## [**VoicemailMailboxInfo**](VoicemailMailboxInfo.html) get_voicemail_me_mailbox
|
420
420
|
|
421
421
|
|
422
422
|
|
@@ -431,7 +431,7 @@ Requires NO permissions:
|
|
431
431
|
|
432
432
|
|
433
433
|
### Example
|
434
|
-
|
434
|
+
```{"language":"ruby"}
|
435
435
|
# load the gem
|
436
436
|
require 'purecloudplatformclientv2'
|
437
437
|
# setup authorization
|
@@ -454,7 +454,7 @@ begin
|
|
454
454
|
rescue PureCloud::ApiError => e
|
455
455
|
puts "Exception when calling VoicemailApi->get_voicemail_me_mailbox: #{e}"
|
456
456
|
end
|
457
|
-
|
457
|
+
```
|
458
458
|
|
459
459
|
### Parameters
|
460
460
|
This endpoint does not need any parameter.
|
@@ -474,7 +474,7 @@ This endpoint does not need any parameter.
|
|
474
474
|
|
475
475
|
<a name="get_voicemail_me_messages"></a>
|
476
476
|
|
477
|
-
##
|
477
|
+
## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_me_messages(opts)
|
478
478
|
|
479
479
|
|
480
480
|
|
@@ -489,7 +489,7 @@ Requires NO permissions:
|
|
489
489
|
|
490
490
|
|
491
491
|
### Example
|
492
|
-
|
492
|
+
```{"language":"ruby"}
|
493
493
|
# load the gem
|
494
494
|
require 'purecloudplatformclientv2'
|
495
495
|
# setup authorization
|
@@ -517,7 +517,7 @@ begin
|
|
517
517
|
rescue PureCloud::ApiError => e
|
518
518
|
puts "Exception when calling VoicemailApi->get_voicemail_me_messages: #{e}"
|
519
519
|
end
|
520
|
-
|
520
|
+
```
|
521
521
|
|
522
522
|
### Parameters
|
523
523
|
|
@@ -541,7 +541,7 @@ Name | Type | Description | Notes
|
|
541
541
|
|
542
542
|
<a name="get_voicemail_me_policy"></a>
|
543
543
|
|
544
|
-
##
|
544
|
+
## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_me_policy
|
545
545
|
|
546
546
|
|
547
547
|
|
@@ -556,7 +556,7 @@ Requires NO permissions:
|
|
556
556
|
|
557
557
|
|
558
558
|
### Example
|
559
|
-
|
559
|
+
```{"language":"ruby"}
|
560
560
|
# load the gem
|
561
561
|
require 'purecloudplatformclientv2'
|
562
562
|
# setup authorization
|
@@ -579,7 +579,7 @@ begin
|
|
579
579
|
rescue PureCloud::ApiError => e
|
580
580
|
puts "Exception when calling VoicemailApi->get_voicemail_me_policy: #{e}"
|
581
581
|
end
|
582
|
-
|
582
|
+
```
|
583
583
|
|
584
584
|
### Parameters
|
585
585
|
This endpoint does not need any parameter.
|
@@ -599,7 +599,7 @@ This endpoint does not need any parameter.
|
|
599
599
|
|
600
600
|
<a name="get_voicemail_message"></a>
|
601
601
|
|
602
|
-
##
|
602
|
+
## [**VoicemailMessage**](VoicemailMessage.html) get_voicemail_message(message_id, opts)
|
603
603
|
|
604
604
|
|
605
605
|
|
@@ -614,7 +614,7 @@ Requires NO permissions:
|
|
614
614
|
|
615
615
|
|
616
616
|
### Example
|
617
|
-
|
617
|
+
```{"language":"ruby"}
|
618
618
|
# load the gem
|
619
619
|
require 'purecloudplatformclientv2'
|
620
620
|
# setup authorization
|
@@ -643,7 +643,7 @@ begin
|
|
643
643
|
rescue PureCloud::ApiError => e
|
644
644
|
puts "Exception when calling VoicemailApi->get_voicemail_message: #{e}"
|
645
645
|
end
|
646
|
-
|
646
|
+
```
|
647
647
|
|
648
648
|
### Parameters
|
649
649
|
|
@@ -667,7 +667,7 @@ Name | Type | Description | Notes
|
|
667
667
|
|
668
668
|
<a name="get_voicemail_message_media"></a>
|
669
669
|
|
670
|
-
##
|
670
|
+
## [**VoicemailMediaInfo**](VoicemailMediaInfo.html) get_voicemail_message_media(message_id, opts)
|
671
671
|
|
672
672
|
|
673
673
|
|
@@ -682,7 +682,7 @@ Requires NO permissions:
|
|
682
682
|
|
683
683
|
|
684
684
|
### Example
|
685
|
-
|
685
|
+
```{"language":"ruby"}
|
686
686
|
# load the gem
|
687
687
|
require 'purecloudplatformclientv2'
|
688
688
|
# setup authorization
|
@@ -711,7 +711,7 @@ begin
|
|
711
711
|
rescue PureCloud::ApiError => e
|
712
712
|
puts "Exception when calling VoicemailApi->get_voicemail_message_media: #{e}"
|
713
713
|
end
|
714
|
-
|
714
|
+
```
|
715
715
|
|
716
716
|
### Parameters
|
717
717
|
|
@@ -735,7 +735,7 @@ Name | Type | Description | Notes
|
|
735
735
|
|
736
736
|
<a name="get_voicemail_messages"></a>
|
737
737
|
|
738
|
-
##
|
738
|
+
## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_messages(opts)
|
739
739
|
|
740
740
|
|
741
741
|
|
@@ -750,7 +750,7 @@ Requires NO permissions:
|
|
750
750
|
|
751
751
|
|
752
752
|
### Example
|
753
|
-
|
753
|
+
```{"language":"ruby"}
|
754
754
|
# load the gem
|
755
755
|
require 'purecloudplatformclientv2'
|
756
756
|
# setup authorization
|
@@ -778,7 +778,7 @@ begin
|
|
778
778
|
rescue PureCloud::ApiError => e
|
779
779
|
puts "Exception when calling VoicemailApi->get_voicemail_messages: #{e}"
|
780
780
|
end
|
781
|
-
|
781
|
+
```
|
782
782
|
|
783
783
|
### Parameters
|
784
784
|
|
@@ -802,7 +802,7 @@ Name | Type | Description | Notes
|
|
802
802
|
|
803
803
|
<a name="get_voicemail_policy"></a>
|
804
804
|
|
805
|
-
##
|
805
|
+
## [**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) get_voicemail_policy
|
806
806
|
|
807
807
|
|
808
808
|
|
@@ -818,7 +818,7 @@ Requires ANY permissions:
|
|
818
818
|
|
819
819
|
|
820
820
|
### Example
|
821
|
-
|
821
|
+
```{"language":"ruby"}
|
822
822
|
# load the gem
|
823
823
|
require 'purecloudplatformclientv2'
|
824
824
|
# setup authorization
|
@@ -841,7 +841,7 @@ begin
|
|
841
841
|
rescue PureCloud::ApiError => e
|
842
842
|
puts "Exception when calling VoicemailApi->get_voicemail_policy: #{e}"
|
843
843
|
end
|
844
|
-
|
844
|
+
```
|
845
845
|
|
846
846
|
### Parameters
|
847
847
|
This endpoint does not need any parameter.
|
@@ -861,7 +861,7 @@ This endpoint does not need any parameter.
|
|
861
861
|
|
862
862
|
<a name="get_voicemail_queue_messages"></a>
|
863
863
|
|
864
|
-
##
|
864
|
+
## [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_queue_messages(queue_id, opts)
|
865
865
|
|
866
866
|
|
867
867
|
|
@@ -877,7 +877,7 @@ Requires ANY permissions:
|
|
877
877
|
|
878
878
|
|
879
879
|
### Example
|
880
|
-
|
880
|
+
```{"language":"ruby"}
|
881
881
|
# load the gem
|
882
882
|
require 'purecloudplatformclientv2'
|
883
883
|
# setup authorization
|
@@ -907,7 +907,7 @@ begin
|
|
907
907
|
rescue PureCloud::ApiError => e
|
908
908
|
puts "Exception when calling VoicemailApi->get_voicemail_queue_messages: #{e}"
|
909
909
|
end
|
910
|
-
|
910
|
+
```
|
911
911
|
|
912
912
|
### Parameters
|
913
913
|
|
@@ -932,7 +932,7 @@ Name | Type | Description | Notes
|
|
932
932
|
|
933
933
|
<a name="get_voicemail_search"></a>
|
934
934
|
|
935
|
-
##
|
935
|
+
## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
|
936
936
|
|
937
937
|
|
938
938
|
|
@@ -947,7 +947,7 @@ Requires NO permissions:
|
|
947
947
|
|
948
948
|
|
949
949
|
### Example
|
950
|
-
|
950
|
+
```{"language":"ruby"}
|
951
951
|
# load the gem
|
952
952
|
require 'purecloudplatformclientv2'
|
953
953
|
# setup authorization
|
@@ -976,7 +976,7 @@ begin
|
|
976
976
|
rescue PureCloud::ApiError => e
|
977
977
|
puts "Exception when calling VoicemailApi->get_voicemail_search: #{e}"
|
978
978
|
end
|
979
|
-
|
979
|
+
```
|
980
980
|
|
981
981
|
### Parameters
|
982
982
|
|
@@ -1000,7 +1000,7 @@ Name | Type | Description | Notes
|
|
1000
1000
|
|
1001
1001
|
<a name="get_voicemail_userpolicy"></a>
|
1002
1002
|
|
1003
|
-
##
|
1003
|
+
## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) get_voicemail_userpolicy(user_id)
|
1004
1004
|
|
1005
1005
|
|
1006
1006
|
|
@@ -1015,7 +1015,7 @@ Requires NO permissions:
|
|
1015
1015
|
|
1016
1016
|
|
1017
1017
|
### Example
|
1018
|
-
|
1018
|
+
```{"language":"ruby"}
|
1019
1019
|
# load the gem
|
1020
1020
|
require 'purecloudplatformclientv2'
|
1021
1021
|
# setup authorization
|
@@ -1041,7 +1041,7 @@ begin
|
|
1041
1041
|
rescue PureCloud::ApiError => e
|
1042
1042
|
puts "Exception when calling VoicemailApi->get_voicemail_userpolicy: #{e}"
|
1043
1043
|
end
|
1044
|
-
|
1044
|
+
```
|
1045
1045
|
|
1046
1046
|
### Parameters
|
1047
1047
|
|
@@ -1064,7 +1064,7 @@ Name | Type | Description | Notes
|
|
1064
1064
|
|
1065
1065
|
<a name="patch_voicemail_group_policy"></a>
|
1066
1066
|
|
1067
|
-
##
|
1067
|
+
## [**VoicemailGroupPolicy**](VoicemailGroupPolicy.html) patch_voicemail_group_policy(group_id, body)
|
1068
1068
|
|
1069
1069
|
|
1070
1070
|
|
@@ -1083,7 +1083,7 @@ Requires ANY permissions:
|
|
1083
1083
|
|
1084
1084
|
|
1085
1085
|
### Example
|
1086
|
-
|
1086
|
+
```{"language":"ruby"}
|
1087
1087
|
# load the gem
|
1088
1088
|
require 'purecloudplatformclientv2'
|
1089
1089
|
# setup authorization
|
@@ -1111,7 +1111,7 @@ begin
|
|
1111
1111
|
rescue PureCloud::ApiError => e
|
1112
1112
|
puts "Exception when calling VoicemailApi->patch_voicemail_group_policy: #{e}"
|
1113
1113
|
end
|
1114
|
-
|
1114
|
+
```
|
1115
1115
|
|
1116
1116
|
### Parameters
|
1117
1117
|
|
@@ -1135,7 +1135,7 @@ Name | Type | Description | Notes
|
|
1135
1135
|
|
1136
1136
|
<a name="patch_voicemail_me_policy"></a>
|
1137
1137
|
|
1138
|
-
##
|
1138
|
+
## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_me_policy(body)
|
1139
1139
|
|
1140
1140
|
|
1141
1141
|
|
@@ -1150,7 +1150,7 @@ Requires NO permissions:
|
|
1150
1150
|
|
1151
1151
|
|
1152
1152
|
### Example
|
1153
|
-
|
1153
|
+
```{"language":"ruby"}
|
1154
1154
|
# load the gem
|
1155
1155
|
require 'purecloudplatformclientv2'
|
1156
1156
|
# setup authorization
|
@@ -1176,7 +1176,7 @@ begin
|
|
1176
1176
|
rescue PureCloud::ApiError => e
|
1177
1177
|
puts "Exception when calling VoicemailApi->patch_voicemail_me_policy: #{e}"
|
1178
1178
|
end
|
1179
|
-
|
1179
|
+
```
|
1180
1180
|
|
1181
1181
|
### Parameters
|
1182
1182
|
|
@@ -1199,7 +1199,7 @@ Name | Type | Description | Notes
|
|
1199
1199
|
|
1200
1200
|
<a name="patch_voicemail_message"></a>
|
1201
1201
|
|
1202
|
-
##
|
1202
|
+
## [**VoicemailMessage**](VoicemailMessage.html) patch_voicemail_message(message_id, body)
|
1203
1203
|
|
1204
1204
|
|
1205
1205
|
|
@@ -1214,7 +1214,7 @@ Requires NO permissions:
|
|
1214
1214
|
|
1215
1215
|
|
1216
1216
|
### Example
|
1217
|
-
|
1217
|
+
```{"language":"ruby"}
|
1218
1218
|
# load the gem
|
1219
1219
|
require 'purecloudplatformclientv2'
|
1220
1220
|
# setup authorization
|
@@ -1242,7 +1242,7 @@ begin
|
|
1242
1242
|
rescue PureCloud::ApiError => e
|
1243
1243
|
puts "Exception when calling VoicemailApi->patch_voicemail_message: #{e}"
|
1244
1244
|
end
|
1245
|
-
|
1245
|
+
```
|
1246
1246
|
|
1247
1247
|
### Parameters
|
1248
1248
|
|
@@ -1266,7 +1266,7 @@ Name | Type | Description | Notes
|
|
1266
1266
|
|
1267
1267
|
<a name="patch_voicemail_userpolicy"></a>
|
1268
1268
|
|
1269
|
-
##
|
1269
|
+
## [**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_userpolicy(user_id, body)
|
1270
1270
|
|
1271
1271
|
|
1272
1272
|
|
@@ -1281,7 +1281,7 @@ Requires NO permissions:
|
|
1281
1281
|
|
1282
1282
|
|
1283
1283
|
### Example
|
1284
|
-
|
1284
|
+
```{"language":"ruby"}
|
1285
1285
|
# load the gem
|
1286
1286
|
require 'purecloudplatformclientv2'
|
1287
1287
|
# setup authorization
|
@@ -1309,7 +1309,7 @@ begin
|
|
1309
1309
|
rescue PureCloud::ApiError => e
|
1310
1310
|
puts "Exception when calling VoicemailApi->patch_voicemail_userpolicy: #{e}"
|
1311
1311
|
end
|
1312
|
-
|
1312
|
+
```
|
1313
1313
|
|
1314
1314
|
### Parameters
|
1315
1315
|
|
@@ -1333,7 +1333,7 @@ Name | Type | Description | Notes
|
|
1333
1333
|
|
1334
1334
|
<a name="post_voicemail_messages"></a>
|
1335
1335
|
|
1336
|
-
##
|
1336
|
+
## [**VoicemailMessage**](VoicemailMessage.html) post_voicemail_messages(opts)
|
1337
1337
|
|
1338
1338
|
|
1339
1339
|
|
@@ -1348,7 +1348,7 @@ Requires NO 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
|
@@ -1375,7 +1375,7 @@ begin
|
|
1375
1375
|
rescue PureCloud::ApiError => e
|
1376
1376
|
puts "Exception when calling VoicemailApi->post_voicemail_messages: #{e}"
|
1377
1377
|
end
|
1378
|
-
|
1378
|
+
```
|
1379
1379
|
|
1380
1380
|
### Parameters
|
1381
1381
|
|
@@ -1398,7 +1398,7 @@ Name | Type | Description | Notes
|
|
1398
1398
|
|
1399
1399
|
<a name="post_voicemail_search"></a>
|
1400
1400
|
|
1401
|
-
##
|
1401
|
+
## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
|
1402
1402
|
|
1403
1403
|
|
1404
1404
|
|
@@ -1413,7 +1413,7 @@ Requires NO 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
|
@@ -1439,7 +1439,7 @@ begin
|
|
1439
1439
|
rescue PureCloud::ApiError => e
|
1440
1440
|
puts "Exception when calling VoicemailApi->post_voicemail_search: #{e}"
|
1441
1441
|
end
|
1442
|
-
|
1442
|
+
```
|
1443
1443
|
|
1444
1444
|
### Parameters
|
1445
1445
|
|
@@ -1462,7 +1462,7 @@ Name | Type | Description | Notes
|
|
1462
1462
|
|
1463
1463
|
<a name="put_voicemail_message"></a>
|
1464
1464
|
|
1465
|
-
##
|
1465
|
+
## [**VoicemailMessage**](VoicemailMessage.html) put_voicemail_message(message_id, body)
|
1466
1466
|
|
1467
1467
|
|
1468
1468
|
|
@@ -1477,7 +1477,7 @@ Requires NO permissions:
|
|
1477
1477
|
|
1478
1478
|
|
1479
1479
|
### Example
|
1480
|
-
|
1480
|
+
```{"language":"ruby"}
|
1481
1481
|
# load the gem
|
1482
1482
|
require 'purecloudplatformclientv2'
|
1483
1483
|
# setup authorization
|
@@ -1505,7 +1505,7 @@ begin
|
|
1505
1505
|
rescue PureCloud::ApiError => e
|
1506
1506
|
puts "Exception when calling VoicemailApi->put_voicemail_message: #{e}"
|
1507
1507
|
end
|
1508
|
-
|
1508
|
+
```
|
1509
1509
|
|
1510
1510
|
### Parameters
|
1511
1511
|
|
@@ -1529,7 +1529,7 @@ Name | Type | Description | Notes
|
|
1529
1529
|
|
1530
1530
|
<a name="put_voicemail_policy"></a>
|
1531
1531
|
|
1532
|
-
##
|
1532
|
+
## [**VoicemailOrganizationPolicy**](VoicemailOrganizationPolicy.html) put_voicemail_policy(body)
|
1533
1533
|
|
1534
1534
|
|
1535
1535
|
|
@@ -1545,7 +1545,7 @@ Requires ANY permissions:
|
|
1545
1545
|
|
1546
1546
|
|
1547
1547
|
### Example
|
1548
|
-
|
1548
|
+
```{"language":"ruby"}
|
1549
1549
|
# load the gem
|
1550
1550
|
require 'purecloudplatformclientv2'
|
1551
1551
|
# setup authorization
|
@@ -1571,7 +1571,7 @@ begin
|
|
1571
1571
|
rescue PureCloud::ApiError => e
|
1572
1572
|
puts "Exception when calling VoicemailApi->put_voicemail_policy: #{e}"
|
1573
1573
|
end
|
1574
|
-
|
1574
|
+
```
|
1575
1575
|
|
1576
1576
|
### Parameters
|
1577
1577
|
|