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
@@ -7,10 +7,11 @@ title: QueueUserEventTopicQueueMember
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **
|
11
|
-
| **
|
10
|
+
| **member_id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **ring_number** | **Integer** | | [optional] |
|
13
|
+
| **type** | **String** | | [optional] |
|
12
14
|
| **joined** | **BOOLEAN** | | [optional] |
|
13
|
-
| **additional_properties** | **Object** | | [optional] |
|
14
15
|
{: class="table table-striped"}
|
15
16
|
|
16
17
|
|
data/docs/RecordingApi.md
CHANGED
@@ -49,7 +49,7 @@ Method | Description
|
|
49
49
|
|
50
50
|
<a name="delete_conversation_recording_annotation"></a>
|
51
51
|
|
52
|
-
##
|
52
|
+
## delete_conversation_recording_annotation(conversation_id, recording_id, annotation_id)
|
53
53
|
|
54
54
|
|
55
55
|
|
@@ -64,7 +64,7 @@ Requires NO permissions:
|
|
64
64
|
|
65
65
|
|
66
66
|
### Example
|
67
|
-
|
67
|
+
```{"language":"ruby"}
|
68
68
|
# load the gem
|
69
69
|
require 'purecloudplatformclientv2'
|
70
70
|
# setup authorization
|
@@ -93,7 +93,7 @@ begin
|
|
93
93
|
rescue PureCloud::ApiError => e
|
94
94
|
puts "Exception when calling RecordingApi->delete_conversation_recording_annotation: #{e}"
|
95
95
|
end
|
96
|
-
|
96
|
+
```
|
97
97
|
|
98
98
|
### Parameters
|
99
99
|
|
@@ -118,7 +118,7 @@ nil (empty response body)
|
|
118
118
|
|
119
119
|
<a name="delete_orphanrecording"></a>
|
120
120
|
|
121
|
-
##
|
121
|
+
## [**OrphanRecording**](OrphanRecording.html) delete_orphanrecording(orphan_id)
|
122
122
|
|
123
123
|
|
124
124
|
|
@@ -134,7 +134,7 @@ Requires ANY permissions:
|
|
134
134
|
|
135
135
|
|
136
136
|
### Example
|
137
|
-
|
137
|
+
```{"language":"ruby"}
|
138
138
|
# load the gem
|
139
139
|
require 'purecloudplatformclientv2'
|
140
140
|
# setup authorization
|
@@ -160,7 +160,7 @@ begin
|
|
160
160
|
rescue PureCloud::ApiError => e
|
161
161
|
puts "Exception when calling RecordingApi->delete_orphanrecording: #{e}"
|
162
162
|
end
|
163
|
-
|
163
|
+
```
|
164
164
|
|
165
165
|
### Parameters
|
166
166
|
|
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
|
|
183
183
|
|
184
184
|
<a name="delete_recording_mediaretentionpolicies"></a>
|
185
185
|
|
186
|
-
##
|
186
|
+
## delete_recording_mediaretentionpolicies(ids)
|
187
187
|
|
188
188
|
|
189
189
|
|
@@ -199,7 +199,7 @@ Requires ANY permissions:
|
|
199
199
|
|
200
200
|
|
201
201
|
### Example
|
202
|
-
|
202
|
+
```{"language":"ruby"}
|
203
203
|
# load the gem
|
204
204
|
require 'purecloudplatformclientv2'
|
205
205
|
# setup authorization
|
@@ -224,7 +224,7 @@ begin
|
|
224
224
|
rescue PureCloud::ApiError => e
|
225
225
|
puts "Exception when calling RecordingApi->delete_recording_mediaretentionpolicies: #{e}"
|
226
226
|
end
|
227
|
-
|
227
|
+
```
|
228
228
|
|
229
229
|
### Parameters
|
230
230
|
|
@@ -247,7 +247,7 @@ nil (empty response body)
|
|
247
247
|
|
248
248
|
<a name="delete_recording_mediaretentionpolicy"></a>
|
249
249
|
|
250
|
-
##
|
250
|
+
## delete_recording_mediaretentionpolicy(policy_id)
|
251
251
|
|
252
252
|
|
253
253
|
|
@@ -263,7 +263,7 @@ Requires ANY permissions:
|
|
263
263
|
|
264
264
|
|
265
265
|
### Example
|
266
|
-
|
266
|
+
```{"language":"ruby"}
|
267
267
|
# load the gem
|
268
268
|
require 'purecloudplatformclientv2'
|
269
269
|
# setup authorization
|
@@ -288,7 +288,7 @@ begin
|
|
288
288
|
rescue PureCloud::ApiError => e
|
289
289
|
puts "Exception when calling RecordingApi->delete_recording_mediaretentionpolicy: #{e}"
|
290
290
|
end
|
291
|
-
|
291
|
+
```
|
292
292
|
|
293
293
|
### Parameters
|
294
294
|
|
@@ -311,7 +311,7 @@ nil (empty response body)
|
|
311
311
|
|
312
312
|
<a name="get_conversation_recording"></a>
|
313
313
|
|
314
|
-
##
|
314
|
+
## [**Recording**](Recording.html) get_conversation_recording(conversation_id, recording_id, opts)
|
315
315
|
|
316
316
|
|
317
317
|
|
@@ -326,7 +326,7 @@ Requires NO permissions:
|
|
326
326
|
|
327
327
|
|
328
328
|
### Example
|
329
|
-
|
329
|
+
```{"language":"ruby"}
|
330
330
|
# load the gem
|
331
331
|
require 'purecloudplatformclientv2'
|
332
332
|
# setup authorization
|
@@ -359,7 +359,7 @@ begin
|
|
359
359
|
rescue PureCloud::ApiError => e
|
360
360
|
puts "Exception when calling RecordingApi->get_conversation_recording: #{e}"
|
361
361
|
end
|
362
|
-
|
362
|
+
```
|
363
363
|
|
364
364
|
### Parameters
|
365
365
|
|
@@ -386,7 +386,7 @@ Name | Type | Description | Notes
|
|
386
386
|
|
387
387
|
<a name="get_conversation_recording_annotation"></a>
|
388
388
|
|
389
|
-
##
|
389
|
+
## [**Annotation**](Annotation.html) get_conversation_recording_annotation(conversation_id, recording_id, annotation_id)
|
390
390
|
|
391
391
|
|
392
392
|
|
@@ -401,7 +401,7 @@ Requires NO permissions:
|
|
401
401
|
|
402
402
|
|
403
403
|
### Example
|
404
|
-
|
404
|
+
```{"language":"ruby"}
|
405
405
|
# load the gem
|
406
406
|
require 'purecloudplatformclientv2'
|
407
407
|
# setup authorization
|
@@ -431,7 +431,7 @@ begin
|
|
431
431
|
rescue PureCloud::ApiError => e
|
432
432
|
puts "Exception when calling RecordingApi->get_conversation_recording_annotation: #{e}"
|
433
433
|
end
|
434
|
-
|
434
|
+
```
|
435
435
|
|
436
436
|
### Parameters
|
437
437
|
|
@@ -456,7 +456,7 @@ Name | Type | Description | Notes
|
|
456
456
|
|
457
457
|
<a name="get_conversation_recording_annotations"></a>
|
458
458
|
|
459
|
-
##
|
459
|
+
## [**Array<Annotation>**](Annotation.html) get_conversation_recording_annotations(conversation_id, recording_id)
|
460
460
|
|
461
461
|
|
462
462
|
|
@@ -471,7 +471,7 @@ Requires NO permissions:
|
|
471
471
|
|
472
472
|
|
473
473
|
### Example
|
474
|
-
|
474
|
+
```{"language":"ruby"}
|
475
475
|
# load the gem
|
476
476
|
require 'purecloudplatformclientv2'
|
477
477
|
# setup authorization
|
@@ -499,7 +499,7 @@ begin
|
|
499
499
|
rescue PureCloud::ApiError => e
|
500
500
|
puts "Exception when calling RecordingApi->get_conversation_recording_annotations: #{e}"
|
501
501
|
end
|
502
|
-
|
502
|
+
```
|
503
503
|
|
504
504
|
### Parameters
|
505
505
|
|
@@ -523,7 +523,7 @@ Name | Type | Description | Notes
|
|
523
523
|
|
524
524
|
<a name="get_conversation_recordingmetadata"></a>
|
525
525
|
|
526
|
-
##
|
526
|
+
## [**Array<Recording>**](Recording.html) get_conversation_recordingmetadata(conversation_id)
|
527
527
|
|
528
528
|
|
529
529
|
|
@@ -538,7 +538,7 @@ Requires NO permissions:
|
|
538
538
|
|
539
539
|
|
540
540
|
### Example
|
541
|
-
|
541
|
+
```{"language":"ruby"}
|
542
542
|
# load the gem
|
543
543
|
require 'purecloudplatformclientv2'
|
544
544
|
# setup authorization
|
@@ -564,7 +564,7 @@ begin
|
|
564
564
|
rescue PureCloud::ApiError => e
|
565
565
|
puts "Exception when calling RecordingApi->get_conversation_recordingmetadata: #{e}"
|
566
566
|
end
|
567
|
-
|
567
|
+
```
|
568
568
|
|
569
569
|
### Parameters
|
570
570
|
|
@@ -587,7 +587,7 @@ Name | Type | Description | Notes
|
|
587
587
|
|
588
588
|
<a name="get_conversation_recordingmetadata_recording_id"></a>
|
589
589
|
|
590
|
-
##
|
590
|
+
## [**Recording**](Recording.html) get_conversation_recordingmetadata_recording_id(conversation_id, recording_id)
|
591
591
|
|
592
592
|
|
593
593
|
|
@@ -602,7 +602,7 @@ Requires NO permissions:
|
|
602
602
|
|
603
603
|
|
604
604
|
### Example
|
605
|
-
|
605
|
+
```{"language":"ruby"}
|
606
606
|
# load the gem
|
607
607
|
require 'purecloudplatformclientv2'
|
608
608
|
# setup authorization
|
@@ -630,7 +630,7 @@ begin
|
|
630
630
|
rescue PureCloud::ApiError => e
|
631
631
|
puts "Exception when calling RecordingApi->get_conversation_recordingmetadata_recording_id: #{e}"
|
632
632
|
end
|
633
|
-
|
633
|
+
```
|
634
634
|
|
635
635
|
### Parameters
|
636
636
|
|
@@ -654,7 +654,7 @@ Name | Type | Description | Notes
|
|
654
654
|
|
655
655
|
<a name="get_conversation_recordings"></a>
|
656
656
|
|
657
|
-
##
|
657
|
+
## [**Array<Recording>**](Recording.html) get_conversation_recordings(conversation_id, opts)
|
658
658
|
|
659
659
|
|
660
660
|
|
@@ -669,7 +669,7 @@ Requires NO permissions:
|
|
669
669
|
|
670
670
|
|
671
671
|
### Example
|
672
|
-
|
672
|
+
```{"language":"ruby"}
|
673
673
|
# load the gem
|
674
674
|
require 'purecloudplatformclientv2'
|
675
675
|
# setup authorization
|
@@ -699,7 +699,7 @@ begin
|
|
699
699
|
rescue PureCloud::ApiError => e
|
700
700
|
puts "Exception when calling RecordingApi->get_conversation_recordings: #{e}"
|
701
701
|
end
|
702
|
-
|
702
|
+
```
|
703
703
|
|
704
704
|
### Parameters
|
705
705
|
|
@@ -724,7 +724,7 @@ Name | Type | Description | Notes
|
|
724
724
|
|
725
725
|
<a name="get_orphanrecording"></a>
|
726
726
|
|
727
|
-
##
|
727
|
+
## [**OrphanRecording**](OrphanRecording.html) get_orphanrecording(orphan_id)
|
728
728
|
|
729
729
|
|
730
730
|
|
@@ -740,7 +740,7 @@ Requires ANY permissions:
|
|
740
740
|
|
741
741
|
|
742
742
|
### Example
|
743
|
-
|
743
|
+
```{"language":"ruby"}
|
744
744
|
# load the gem
|
745
745
|
require 'purecloudplatformclientv2'
|
746
746
|
# setup authorization
|
@@ -766,7 +766,7 @@ begin
|
|
766
766
|
rescue PureCloud::ApiError => e
|
767
767
|
puts "Exception when calling RecordingApi->get_orphanrecording: #{e}"
|
768
768
|
end
|
769
|
-
|
769
|
+
```
|
770
770
|
|
771
771
|
### Parameters
|
772
772
|
|
@@ -789,7 +789,7 @@ Name | Type | Description | Notes
|
|
789
789
|
|
790
790
|
<a name="get_orphanrecording_media"></a>
|
791
791
|
|
792
|
-
##
|
792
|
+
## [**Recording**](Recording.html) get_orphanrecording_media(orphan_id, opts)
|
793
793
|
|
794
794
|
|
795
795
|
|
@@ -804,7 +804,7 @@ Requires NO permissions:
|
|
804
804
|
|
805
805
|
|
806
806
|
### Example
|
807
|
-
|
807
|
+
```{"language":"ruby"}
|
808
808
|
# load the gem
|
809
809
|
require 'purecloudplatformclientv2'
|
810
810
|
# setup authorization
|
@@ -835,7 +835,7 @@ begin
|
|
835
835
|
rescue PureCloud::ApiError => e
|
836
836
|
puts "Exception when calling RecordingApi->get_orphanrecording_media: #{e}"
|
837
837
|
end
|
838
|
-
|
838
|
+
```
|
839
839
|
|
840
840
|
### Parameters
|
841
841
|
|
@@ -861,7 +861,7 @@ Name | Type | Description | Notes
|
|
861
861
|
|
862
862
|
<a name="get_orphanrecordings"></a>
|
863
863
|
|
864
|
-
##
|
864
|
+
## [**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(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
|
@@ -911,7 +911,7 @@ begin
|
|
911
911
|
rescue PureCloud::ApiError => e
|
912
912
|
puts "Exception when calling RecordingApi->get_orphanrecordings: #{e}"
|
913
913
|
end
|
914
|
-
|
914
|
+
```
|
915
915
|
|
916
916
|
### Parameters
|
917
917
|
|
@@ -941,7 +941,7 @@ Name | Type | Description | Notes
|
|
941
941
|
|
942
942
|
<a name="get_recording_batchrequest"></a>
|
943
943
|
|
944
|
-
##
|
944
|
+
## [**BatchDownloadJobStatusResult**](BatchDownloadJobStatusResult.html) get_recording_batchrequest(job_id)
|
945
945
|
|
946
946
|
|
947
947
|
|
@@ -956,7 +956,7 @@ Requires NO permissions:
|
|
956
956
|
|
957
957
|
|
958
958
|
### Example
|
959
|
-
|
959
|
+
```{"language":"ruby"}
|
960
960
|
# load the gem
|
961
961
|
require 'purecloudplatformclientv2'
|
962
962
|
# setup authorization
|
@@ -982,7 +982,7 @@ begin
|
|
982
982
|
rescue PureCloud::ApiError => e
|
983
983
|
puts "Exception when calling RecordingApi->get_recording_batchrequest: #{e}"
|
984
984
|
end
|
985
|
-
|
985
|
+
```
|
986
986
|
|
987
987
|
### Parameters
|
988
988
|
|
@@ -1005,7 +1005,7 @@ Name | Type | Description | Notes
|
|
1005
1005
|
|
1006
1006
|
<a name="get_recording_localkeys_setting"></a>
|
1007
1007
|
|
1008
|
-
##
|
1008
|
+
## [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_recording_localkeys_setting(settings_id)
|
1009
1009
|
|
1010
1010
|
|
1011
1011
|
|
@@ -1021,7 +1021,7 @@ Requires ANY permissions:
|
|
1021
1021
|
|
1022
1022
|
|
1023
1023
|
### Example
|
1024
|
-
|
1024
|
+
```{"language":"ruby"}
|
1025
1025
|
# load the gem
|
1026
1026
|
require 'purecloudplatformclientv2'
|
1027
1027
|
# setup authorization
|
@@ -1047,7 +1047,7 @@ begin
|
|
1047
1047
|
rescue PureCloud::ApiError => e
|
1048
1048
|
puts "Exception when calling RecordingApi->get_recording_localkeys_setting: #{e}"
|
1049
1049
|
end
|
1050
|
-
|
1050
|
+
```
|
1051
1051
|
|
1052
1052
|
### Parameters
|
1053
1053
|
|
@@ -1070,7 +1070,7 @@ Name | Type | Description | Notes
|
|
1070
1070
|
|
1071
1071
|
<a name="get_recording_localkeys_settings"></a>
|
1072
1072
|
|
1073
|
-
##
|
1073
|
+
## [**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html) get_recording_localkeys_settings
|
1074
1074
|
|
1075
1075
|
|
1076
1076
|
|
@@ -1086,7 +1086,7 @@ Requires ANY permissions:
|
|
1086
1086
|
|
1087
1087
|
|
1088
1088
|
### Example
|
1089
|
-
|
1089
|
+
```{"language":"ruby"}
|
1090
1090
|
# load the gem
|
1091
1091
|
require 'purecloudplatformclientv2'
|
1092
1092
|
# setup authorization
|
@@ -1109,7 +1109,7 @@ begin
|
|
1109
1109
|
rescue PureCloud::ApiError => e
|
1110
1110
|
puts "Exception when calling RecordingApi->get_recording_localkeys_settings: #{e}"
|
1111
1111
|
end
|
1112
|
-
|
1112
|
+
```
|
1113
1113
|
|
1114
1114
|
### Parameters
|
1115
1115
|
This endpoint does not need any parameter.
|
@@ -1129,7 +1129,7 @@ This endpoint does not need any parameter.
|
|
1129
1129
|
|
1130
1130
|
<a name="get_recording_mediaretentionpolicies"></a>
|
1131
1131
|
|
1132
|
-
##
|
1132
|
+
## [**PolicyEntityListing**](PolicyEntityListing.html) get_recording_mediaretentionpolicies(opts)
|
1133
1133
|
|
1134
1134
|
|
1135
1135
|
|
@@ -1145,7 +1145,7 @@ Requires ANY permissions:
|
|
1145
1145
|
|
1146
1146
|
|
1147
1147
|
### Example
|
1148
|
-
|
1148
|
+
```{"language":"ruby"}
|
1149
1149
|
# load the gem
|
1150
1150
|
require 'purecloudplatformclientv2'
|
1151
1151
|
# setup authorization
|
@@ -1181,7 +1181,7 @@ begin
|
|
1181
1181
|
rescue PureCloud::ApiError => e
|
1182
1182
|
puts "Exception when calling RecordingApi->get_recording_mediaretentionpolicies: #{e}"
|
1183
1183
|
end
|
1184
|
-
|
1184
|
+
```
|
1185
1185
|
|
1186
1186
|
### Parameters
|
1187
1187
|
|
@@ -1213,7 +1213,7 @@ Name | Type | Description | Notes
|
|
1213
1213
|
|
1214
1214
|
<a name="get_recording_mediaretentionpolicy"></a>
|
1215
1215
|
|
1216
|
-
##
|
1216
|
+
## [**Policy**](Policy.html) get_recording_mediaretentionpolicy(policy_id)
|
1217
1217
|
|
1218
1218
|
|
1219
1219
|
|
@@ -1229,7 +1229,7 @@ Requires ANY permissions:
|
|
1229
1229
|
|
1230
1230
|
|
1231
1231
|
### Example
|
1232
|
-
|
1232
|
+
```{"language":"ruby"}
|
1233
1233
|
# load the gem
|
1234
1234
|
require 'purecloudplatformclientv2'
|
1235
1235
|
# setup authorization
|
@@ -1255,7 +1255,7 @@ begin
|
|
1255
1255
|
rescue PureCloud::ApiError => e
|
1256
1256
|
puts "Exception when calling RecordingApi->get_recording_mediaretentionpolicy: #{e}"
|
1257
1257
|
end
|
1258
|
-
|
1258
|
+
```
|
1259
1259
|
|
1260
1260
|
### Parameters
|
1261
1261
|
|
@@ -1278,7 +1278,7 @@ Name | Type | Description | Notes
|
|
1278
1278
|
|
1279
1279
|
<a name="get_recording_recordingkeys"></a>
|
1280
1280
|
|
1281
|
-
##
|
1281
|
+
## [**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recording_recordingkeys(opts)
|
1282
1282
|
|
1283
1283
|
|
1284
1284
|
|
@@ -1294,7 +1294,7 @@ Requires ANY permissions:
|
|
1294
1294
|
|
1295
1295
|
|
1296
1296
|
### Example
|
1297
|
-
|
1297
|
+
```{"language":"ruby"}
|
1298
1298
|
# load the gem
|
1299
1299
|
require 'purecloudplatformclientv2'
|
1300
1300
|
# setup authorization
|
@@ -1322,7 +1322,7 @@ begin
|
|
1322
1322
|
rescue PureCloud::ApiError => e
|
1323
1323
|
puts "Exception when calling RecordingApi->get_recording_recordingkeys: #{e}"
|
1324
1324
|
end
|
1325
|
-
|
1325
|
+
```
|
1326
1326
|
|
1327
1327
|
### Parameters
|
1328
1328
|
|
@@ -1346,7 +1346,7 @@ Name | Type | Description | Notes
|
|
1346
1346
|
|
1347
1347
|
<a name="get_recording_recordingkeys_rotationschedule"></a>
|
1348
1348
|
|
1349
|
-
##
|
1349
|
+
## [**KeyRotationSchedule**](KeyRotationSchedule.html) get_recording_recordingkeys_rotationschedule
|
1350
1350
|
|
1351
1351
|
|
1352
1352
|
|
@@ -1362,7 +1362,7 @@ Requires ANY permissions:
|
|
1362
1362
|
|
1363
1363
|
|
1364
1364
|
### Example
|
1365
|
-
|
1365
|
+
```{"language":"ruby"}
|
1366
1366
|
# load the gem
|
1367
1367
|
require 'purecloudplatformclientv2'
|
1368
1368
|
# setup authorization
|
@@ -1385,7 +1385,7 @@ begin
|
|
1385
1385
|
rescue PureCloud::ApiError => e
|
1386
1386
|
puts "Exception when calling RecordingApi->get_recording_recordingkeys_rotationschedule: #{e}"
|
1387
1387
|
end
|
1388
|
-
|
1388
|
+
```
|
1389
1389
|
|
1390
1390
|
### Parameters
|
1391
1391
|
This endpoint does not need any parameter.
|
@@ -1405,7 +1405,7 @@ This endpoint does not need any parameter.
|
|
1405
1405
|
|
1406
1406
|
<a name="get_recording_settings"></a>
|
1407
1407
|
|
1408
|
-
##
|
1408
|
+
## [**RecordingSettings**](RecordingSettings.html) get_recording_settings(opts)
|
1409
1409
|
|
1410
1410
|
|
1411
1411
|
|
@@ -1420,7 +1420,7 @@ Requires NO permissions:
|
|
1420
1420
|
|
1421
1421
|
|
1422
1422
|
### Example
|
1423
|
-
|
1423
|
+
```{"language":"ruby"}
|
1424
1424
|
# load the gem
|
1425
1425
|
require 'purecloudplatformclientv2'
|
1426
1426
|
# setup authorization
|
@@ -1447,7 +1447,7 @@ begin
|
|
1447
1447
|
rescue PureCloud::ApiError => e
|
1448
1448
|
puts "Exception when calling RecordingApi->get_recording_settings: #{e}"
|
1449
1449
|
end
|
1450
|
-
|
1450
|
+
```
|
1451
1451
|
|
1452
1452
|
### Parameters
|
1453
1453
|
|
@@ -1470,7 +1470,7 @@ Name | Type | Description | Notes
|
|
1470
1470
|
|
1471
1471
|
<a name="get_recordings_screensessions"></a>
|
1472
1472
|
|
1473
|
-
##
|
1473
|
+
## [**ScreenRecordingSessionListing**](ScreenRecordingSessionListing.html) get_recordings_screensessions(opts)
|
1474
1474
|
|
1475
1475
|
|
1476
1476
|
|
@@ -1485,7 +1485,7 @@ Requires NO permissions:
|
|
1485
1485
|
|
1486
1486
|
|
1487
1487
|
### Example
|
1488
|
-
|
1488
|
+
```{"language":"ruby"}
|
1489
1489
|
# load the gem
|
1490
1490
|
require 'purecloudplatformclientv2'
|
1491
1491
|
# setup authorization
|
@@ -1513,7 +1513,7 @@ begin
|
|
1513
1513
|
rescue PureCloud::ApiError => e
|
1514
1514
|
puts "Exception when calling RecordingApi->get_recordings_screensessions: #{e}"
|
1515
1515
|
end
|
1516
|
-
|
1516
|
+
```
|
1517
1517
|
|
1518
1518
|
### Parameters
|
1519
1519
|
|
@@ -1537,7 +1537,7 @@ Name | Type | Description | Notes
|
|
1537
1537
|
|
1538
1538
|
<a name="patch_recording_mediaretentionpolicy"></a>
|
1539
1539
|
|
1540
|
-
##
|
1540
|
+
## [**Policy**](Policy.html) patch_recording_mediaretentionpolicy(policy_id, body)
|
1541
1541
|
|
1542
1542
|
|
1543
1543
|
|
@@ -1553,7 +1553,7 @@ Requires ANY 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
|
@@ -1581,7 +1581,7 @@ begin
|
|
1581
1581
|
rescue PureCloud::ApiError => e
|
1582
1582
|
puts "Exception when calling RecordingApi->patch_recording_mediaretentionpolicy: #{e}"
|
1583
1583
|
end
|
1584
|
-
|
1584
|
+
```
|
1585
1585
|
|
1586
1586
|
### Parameters
|
1587
1587
|
|
@@ -1605,7 +1605,7 @@ Name | Type | Description | Notes
|
|
1605
1605
|
|
1606
1606
|
<a name="patch_recordings_screensession"></a>
|
1607
1607
|
|
1608
|
-
##
|
1608
|
+
## patch_recordings_screensession(recording_session_id, opts)
|
1609
1609
|
|
1610
1610
|
|
1611
1611
|
|
@@ -1620,7 +1620,7 @@ Requires NO permissions:
|
|
1620
1620
|
|
1621
1621
|
|
1622
1622
|
### Example
|
1623
|
-
|
1623
|
+
```{"language":"ruby"}
|
1624
1624
|
# load the gem
|
1625
1625
|
require 'purecloudplatformclientv2'
|
1626
1626
|
# setup authorization
|
@@ -1648,7 +1648,7 @@ begin
|
|
1648
1648
|
rescue PureCloud::ApiError => e
|
1649
1649
|
puts "Exception when calling RecordingApi->patch_recordings_screensession: #{e}"
|
1650
1650
|
end
|
1651
|
-
|
1651
|
+
```
|
1652
1652
|
|
1653
1653
|
### Parameters
|
1654
1654
|
|
@@ -1672,7 +1672,7 @@ nil (empty response body)
|
|
1672
1672
|
|
1673
1673
|
<a name="post_conversation_recording_annotations"></a>
|
1674
1674
|
|
1675
|
-
##
|
1675
|
+
## [**Annotation**](Annotation.html) post_conversation_recording_annotations(conversation_id, recording_id, body)
|
1676
1676
|
|
1677
1677
|
|
1678
1678
|
|
@@ -1687,7 +1687,7 @@ Requires NO permissions:
|
|
1687
1687
|
|
1688
1688
|
|
1689
1689
|
### Example
|
1690
|
-
|
1690
|
+
```{"language":"ruby"}
|
1691
1691
|
# load the gem
|
1692
1692
|
require 'purecloudplatformclientv2'
|
1693
1693
|
# setup authorization
|
@@ -1717,7 +1717,7 @@ begin
|
|
1717
1717
|
rescue PureCloud::ApiError => e
|
1718
1718
|
puts "Exception when calling RecordingApi->post_conversation_recording_annotations: #{e}"
|
1719
1719
|
end
|
1720
|
-
|
1720
|
+
```
|
1721
1721
|
|
1722
1722
|
### Parameters
|
1723
1723
|
|
@@ -1742,7 +1742,7 @@ Name | Type | Description | Notes
|
|
1742
1742
|
|
1743
1743
|
<a name="post_recording_batchrequests"></a>
|
1744
1744
|
|
1745
|
-
##
|
1745
|
+
## [**BatchDownloadJobSubmissionResult**](BatchDownloadJobSubmissionResult.html) post_recording_batchrequests(body)
|
1746
1746
|
|
1747
1747
|
|
1748
1748
|
|
@@ -1757,7 +1757,7 @@ Requires NO permissions:
|
|
1757
1757
|
|
1758
1758
|
|
1759
1759
|
### Example
|
1760
|
-
|
1760
|
+
```{"language":"ruby"}
|
1761
1761
|
# load the gem
|
1762
1762
|
require 'purecloudplatformclientv2'
|
1763
1763
|
# setup authorization
|
@@ -1783,7 +1783,7 @@ begin
|
|
1783
1783
|
rescue PureCloud::ApiError => e
|
1784
1784
|
puts "Exception when calling RecordingApi->post_recording_batchrequests: #{e}"
|
1785
1785
|
end
|
1786
|
-
|
1786
|
+
```
|
1787
1787
|
|
1788
1788
|
### Parameters
|
1789
1789
|
|
@@ -1806,7 +1806,7 @@ Name | Type | Description | Notes
|
|
1806
1806
|
|
1807
1807
|
<a name="post_recording_localkeys"></a>
|
1808
1808
|
|
1809
|
-
##
|
1809
|
+
## [**EncryptionKey**](EncryptionKey.html) post_recording_localkeys(body)
|
1810
1810
|
|
1811
1811
|
|
1812
1812
|
|
@@ -1822,7 +1822,7 @@ Requires ANY permissions:
|
|
1822
1822
|
|
1823
1823
|
|
1824
1824
|
### Example
|
1825
|
-
|
1825
|
+
```{"language":"ruby"}
|
1826
1826
|
# load the gem
|
1827
1827
|
require 'purecloudplatformclientv2'
|
1828
1828
|
# setup authorization
|
@@ -1848,7 +1848,7 @@ begin
|
|
1848
1848
|
rescue PureCloud::ApiError => e
|
1849
1849
|
puts "Exception when calling RecordingApi->post_recording_localkeys: #{e}"
|
1850
1850
|
end
|
1851
|
-
|
1851
|
+
```
|
1852
1852
|
|
1853
1853
|
### Parameters
|
1854
1854
|
|
@@ -1871,7 +1871,7 @@ Name | Type | Description | Notes
|
|
1871
1871
|
|
1872
1872
|
<a name="post_recording_localkeys_settings"></a>
|
1873
1873
|
|
1874
|
-
##
|
1874
|
+
## [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) post_recording_localkeys_settings(body)
|
1875
1875
|
|
1876
1876
|
|
1877
1877
|
|
@@ -1887,7 +1887,7 @@ Requires ANY permissions:
|
|
1887
1887
|
|
1888
1888
|
|
1889
1889
|
### Example
|
1890
|
-
|
1890
|
+
```{"language":"ruby"}
|
1891
1891
|
# load the gem
|
1892
1892
|
require 'purecloudplatformclientv2'
|
1893
1893
|
# setup authorization
|
@@ -1913,7 +1913,7 @@ begin
|
|
1913
1913
|
rescue PureCloud::ApiError => e
|
1914
1914
|
puts "Exception when calling RecordingApi->post_recording_localkeys_settings: #{e}"
|
1915
1915
|
end
|
1916
|
-
|
1916
|
+
```
|
1917
1917
|
|
1918
1918
|
### Parameters
|
1919
1919
|
|
@@ -1936,7 +1936,7 @@ Name | Type | Description | Notes
|
|
1936
1936
|
|
1937
1937
|
<a name="post_recording_mediaretentionpolicies"></a>
|
1938
1938
|
|
1939
|
-
##
|
1939
|
+
## [**Policy**](Policy.html) post_recording_mediaretentionpolicies(body)
|
1940
1940
|
|
1941
1941
|
|
1942
1942
|
|
@@ -1952,7 +1952,7 @@ Requires ANY permissions:
|
|
1952
1952
|
|
1953
1953
|
|
1954
1954
|
### Example
|
1955
|
-
|
1955
|
+
```{"language":"ruby"}
|
1956
1956
|
# load the gem
|
1957
1957
|
require 'purecloudplatformclientv2'
|
1958
1958
|
# setup authorization
|
@@ -1978,7 +1978,7 @@ begin
|
|
1978
1978
|
rescue PureCloud::ApiError => e
|
1979
1979
|
puts "Exception when calling RecordingApi->post_recording_mediaretentionpolicies: #{e}"
|
1980
1980
|
end
|
1981
|
-
|
1981
|
+
```
|
1982
1982
|
|
1983
1983
|
### Parameters
|
1984
1984
|
|
@@ -2001,7 +2001,7 @@ Name | Type | Description | Notes
|
|
2001
2001
|
|
2002
2002
|
<a name="post_recording_recordingkeys"></a>
|
2003
2003
|
|
2004
|
-
##
|
2004
|
+
## [**EncryptionKey**](EncryptionKey.html) post_recording_recordingkeys
|
2005
2005
|
|
2006
2006
|
|
2007
2007
|
|
@@ -2017,7 +2017,7 @@ Requires ANY permissions:
|
|
2017
2017
|
|
2018
2018
|
|
2019
2019
|
### Example
|
2020
|
-
|
2020
|
+
```{"language":"ruby"}
|
2021
2021
|
# load the gem
|
2022
2022
|
require 'purecloudplatformclientv2'
|
2023
2023
|
# setup authorization
|
@@ -2040,7 +2040,7 @@ begin
|
|
2040
2040
|
rescue PureCloud::ApiError => e
|
2041
2041
|
puts "Exception when calling RecordingApi->post_recording_recordingkeys: #{e}"
|
2042
2042
|
end
|
2043
|
-
|
2043
|
+
```
|
2044
2044
|
|
2045
2045
|
### Parameters
|
2046
2046
|
This endpoint does not need any parameter.
|
@@ -2060,7 +2060,7 @@ This endpoint does not need any parameter.
|
|
2060
2060
|
|
2061
2061
|
<a name="put_conversation_recording"></a>
|
2062
2062
|
|
2063
|
-
##
|
2063
|
+
## [**Recording**](Recording.html) put_conversation_recording(conversation_id, recording_id, body)
|
2064
2064
|
|
2065
2065
|
|
2066
2066
|
|
@@ -2075,7 +2075,7 @@ Requires NO permissions:
|
|
2075
2075
|
|
2076
2076
|
|
2077
2077
|
### Example
|
2078
|
-
|
2078
|
+
```{"language":"ruby"}
|
2079
2079
|
# load the gem
|
2080
2080
|
require 'purecloudplatformclientv2'
|
2081
2081
|
# setup authorization
|
@@ -2105,7 +2105,7 @@ begin
|
|
2105
2105
|
rescue PureCloud::ApiError => e
|
2106
2106
|
puts "Exception when calling RecordingApi->put_conversation_recording: #{e}"
|
2107
2107
|
end
|
2108
|
-
|
2108
|
+
```
|
2109
2109
|
|
2110
2110
|
### Parameters
|
2111
2111
|
|
@@ -2130,7 +2130,7 @@ Name | Type | Description | Notes
|
|
2130
2130
|
|
2131
2131
|
<a name="put_conversation_recording_annotation"></a>
|
2132
2132
|
|
2133
|
-
##
|
2133
|
+
## [**Annotation**](Annotation.html) put_conversation_recording_annotation(conversation_id, recording_id, annotation_id, body)
|
2134
2134
|
|
2135
2135
|
|
2136
2136
|
|
@@ -2145,7 +2145,7 @@ Requires NO permissions:
|
|
2145
2145
|
|
2146
2146
|
|
2147
2147
|
### Example
|
2148
|
-
|
2148
|
+
```{"language":"ruby"}
|
2149
2149
|
# load the gem
|
2150
2150
|
require 'purecloudplatformclientv2'
|
2151
2151
|
# setup authorization
|
@@ -2177,7 +2177,7 @@ begin
|
|
2177
2177
|
rescue PureCloud::ApiError => e
|
2178
2178
|
puts "Exception when calling RecordingApi->put_conversation_recording_annotation: #{e}"
|
2179
2179
|
end
|
2180
|
-
|
2180
|
+
```
|
2181
2181
|
|
2182
2182
|
### Parameters
|
2183
2183
|
|
@@ -2203,7 +2203,7 @@ Name | Type | Description | Notes
|
|
2203
2203
|
|
2204
2204
|
<a name="put_orphanrecording"></a>
|
2205
2205
|
|
2206
|
-
##
|
2206
|
+
## [**Recording**](Recording.html) put_orphanrecording(orphan_id, opts)
|
2207
2207
|
|
2208
2208
|
|
2209
2209
|
|
@@ -2219,7 +2219,7 @@ Requires ANY permissions:
|
|
2219
2219
|
|
2220
2220
|
|
2221
2221
|
### Example
|
2222
|
-
|
2222
|
+
```{"language":"ruby"}
|
2223
2223
|
# load the gem
|
2224
2224
|
require 'purecloudplatformclientv2'
|
2225
2225
|
# setup authorization
|
@@ -2248,7 +2248,7 @@ begin
|
|
2248
2248
|
rescue PureCloud::ApiError => e
|
2249
2249
|
puts "Exception when calling RecordingApi->put_orphanrecording: #{e}"
|
2250
2250
|
end
|
2251
|
-
|
2251
|
+
```
|
2252
2252
|
|
2253
2253
|
### Parameters
|
2254
2254
|
|
@@ -2272,7 +2272,7 @@ Name | Type | Description | Notes
|
|
2272
2272
|
|
2273
2273
|
<a name="put_recording_localkeys_setting"></a>
|
2274
2274
|
|
2275
|
-
##
|
2275
|
+
## [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) put_recording_localkeys_setting(settings_id, body)
|
2276
2276
|
|
2277
2277
|
|
2278
2278
|
|
@@ -2288,7 +2288,7 @@ Requires ANY permissions:
|
|
2288
2288
|
|
2289
2289
|
|
2290
2290
|
### Example
|
2291
|
-
|
2291
|
+
```{"language":"ruby"}
|
2292
2292
|
# load the gem
|
2293
2293
|
require 'purecloudplatformclientv2'
|
2294
2294
|
# setup authorization
|
@@ -2316,7 +2316,7 @@ begin
|
|
2316
2316
|
rescue PureCloud::ApiError => e
|
2317
2317
|
puts "Exception when calling RecordingApi->put_recording_localkeys_setting: #{e}"
|
2318
2318
|
end
|
2319
|
-
|
2319
|
+
```
|
2320
2320
|
|
2321
2321
|
### Parameters
|
2322
2322
|
|
@@ -2340,7 +2340,7 @@ Name | Type | Description | Notes
|
|
2340
2340
|
|
2341
2341
|
<a name="put_recording_mediaretentionpolicy"></a>
|
2342
2342
|
|
2343
|
-
##
|
2343
|
+
## [**Policy**](Policy.html) put_recording_mediaretentionpolicy(policy_id, body)
|
2344
2344
|
|
2345
2345
|
|
2346
2346
|
|
@@ -2356,7 +2356,7 @@ Requires ANY permissions:
|
|
2356
2356
|
|
2357
2357
|
|
2358
2358
|
### Example
|
2359
|
-
|
2359
|
+
```{"language":"ruby"}
|
2360
2360
|
# load the gem
|
2361
2361
|
require 'purecloudplatformclientv2'
|
2362
2362
|
# setup authorization
|
@@ -2384,7 +2384,7 @@ begin
|
|
2384
2384
|
rescue PureCloud::ApiError => e
|
2385
2385
|
puts "Exception when calling RecordingApi->put_recording_mediaretentionpolicy: #{e}"
|
2386
2386
|
end
|
2387
|
-
|
2387
|
+
```
|
2388
2388
|
|
2389
2389
|
### Parameters
|
2390
2390
|
|
@@ -2408,7 +2408,7 @@ Name | Type | Description | Notes
|
|
2408
2408
|
|
2409
2409
|
<a name="put_recording_recordingkeys_rotationschedule"></a>
|
2410
2410
|
|
2411
|
-
##
|
2411
|
+
## [**KeyRotationSchedule**](KeyRotationSchedule.html) put_recording_recordingkeys_rotationschedule(body)
|
2412
2412
|
|
2413
2413
|
|
2414
2414
|
|
@@ -2424,7 +2424,7 @@ Requires ANY permissions:
|
|
2424
2424
|
|
2425
2425
|
|
2426
2426
|
### Example
|
2427
|
-
|
2427
|
+
```{"language":"ruby"}
|
2428
2428
|
# load the gem
|
2429
2429
|
require 'purecloudplatformclientv2'
|
2430
2430
|
# setup authorization
|
@@ -2450,7 +2450,7 @@ begin
|
|
2450
2450
|
rescue PureCloud::ApiError => e
|
2451
2451
|
puts "Exception when calling RecordingApi->put_recording_recordingkeys_rotationschedule: #{e}"
|
2452
2452
|
end
|
2453
|
-
|
2453
|
+
```
|
2454
2454
|
|
2455
2455
|
### Parameters
|
2456
2456
|
|
@@ -2473,7 +2473,7 @@ Name | Type | Description | Notes
|
|
2473
2473
|
|
2474
2474
|
<a name="put_recording_settings"></a>
|
2475
2475
|
|
2476
|
-
##
|
2476
|
+
## [**RecordingSettings**](RecordingSettings.html) put_recording_settings(body)
|
2477
2477
|
|
2478
2478
|
|
2479
2479
|
|
@@ -2488,7 +2488,7 @@ Requires NO permissions:
|
|
2488
2488
|
|
2489
2489
|
|
2490
2490
|
### Example
|
2491
|
-
|
2491
|
+
```{"language":"ruby"}
|
2492
2492
|
# load the gem
|
2493
2493
|
require 'purecloudplatformclientv2'
|
2494
2494
|
# setup authorization
|
@@ -2514,7 +2514,7 @@ begin
|
|
2514
2514
|
rescue PureCloud::ApiError => e
|
2515
2515
|
puts "Exception when calling RecordingApi->put_recording_settings: #{e}"
|
2516
2516
|
end
|
2517
|
-
|
2517
|
+
```
|
2518
2518
|
|
2519
2519
|
### Parameters
|
2520
2520
|
|