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/MobileDevicesApi.md
CHANGED
@@ -17,7 +17,7 @@ Method | Description
|
|
17
17
|
|
18
18
|
<a name="delete_mobiledevice"></a>
|
19
19
|
|
20
|
-
##
|
20
|
+
## delete_mobiledevice(device_id)
|
21
21
|
|
22
22
|
|
23
23
|
|
@@ -32,7 +32,7 @@ Requires NO permissions:
|
|
32
32
|
|
33
33
|
|
34
34
|
### Example
|
35
|
-
|
35
|
+
```{"language":"ruby"}
|
36
36
|
# load the gem
|
37
37
|
require 'purecloudplatformclientv2'
|
38
38
|
# setup authorization
|
@@ -57,7 +57,7 @@ begin
|
|
57
57
|
rescue PureCloud::ApiError => e
|
58
58
|
puts "Exception when calling MobileDevicesApi->delete_mobiledevice: #{e}"
|
59
59
|
end
|
60
|
-
|
60
|
+
```
|
61
61
|
|
62
62
|
### Parameters
|
63
63
|
|
@@ -80,7 +80,7 @@ nil (empty response body)
|
|
80
80
|
|
81
81
|
<a name="get_mobiledevice"></a>
|
82
82
|
|
83
|
-
##
|
83
|
+
## [**UserDevice**](UserDevice.html) get_mobiledevice(device_id)
|
84
84
|
|
85
85
|
|
86
86
|
|
@@ -95,7 +95,7 @@ Requires NO permissions:
|
|
95
95
|
|
96
96
|
|
97
97
|
### Example
|
98
|
-
|
98
|
+
```{"language":"ruby"}
|
99
99
|
# load the gem
|
100
100
|
require 'purecloudplatformclientv2'
|
101
101
|
# setup authorization
|
@@ -121,7 +121,7 @@ begin
|
|
121
121
|
rescue PureCloud::ApiError => e
|
122
122
|
puts "Exception when calling MobileDevicesApi->get_mobiledevice: #{e}"
|
123
123
|
end
|
124
|
-
|
124
|
+
```
|
125
125
|
|
126
126
|
### Parameters
|
127
127
|
|
@@ -144,7 +144,7 @@ Name | Type | Description | Notes
|
|
144
144
|
|
145
145
|
<a name="get_mobiledevices"></a>
|
146
146
|
|
147
|
-
##
|
147
|
+
## [**DirectoryUserDevicesListing**](DirectoryUserDevicesListing.html) get_mobiledevices(opts)
|
148
148
|
|
149
149
|
|
150
150
|
|
@@ -159,7 +159,7 @@ Requires NO permissions:
|
|
159
159
|
|
160
160
|
|
161
161
|
### Example
|
162
|
-
|
162
|
+
```{"language":"ruby"}
|
163
163
|
# load the gem
|
164
164
|
require 'purecloudplatformclientv2'
|
165
165
|
# setup authorization
|
@@ -188,7 +188,7 @@ begin
|
|
188
188
|
rescue PureCloud::ApiError => e
|
189
189
|
puts "Exception when calling MobileDevicesApi->get_mobiledevices: #{e}"
|
190
190
|
end
|
191
|
-
|
191
|
+
```
|
192
192
|
|
193
193
|
### Parameters
|
194
194
|
|
@@ -213,7 +213,7 @@ Name | Type | Description | Notes
|
|
213
213
|
|
214
214
|
<a name="post_mobiledevices"></a>
|
215
215
|
|
216
|
-
##
|
216
|
+
## [**UserDevice**](UserDevice.html) post_mobiledevices(body)
|
217
217
|
|
218
218
|
|
219
219
|
|
@@ -228,7 +228,7 @@ Requires NO permissions:
|
|
228
228
|
|
229
229
|
|
230
230
|
### Example
|
231
|
-
|
231
|
+
```{"language":"ruby"}
|
232
232
|
# load the gem
|
233
233
|
require 'purecloudplatformclientv2'
|
234
234
|
# setup authorization
|
@@ -254,7 +254,7 @@ begin
|
|
254
254
|
rescue PureCloud::ApiError => e
|
255
255
|
puts "Exception when calling MobileDevicesApi->post_mobiledevices: #{e}"
|
256
256
|
end
|
257
|
-
|
257
|
+
```
|
258
258
|
|
259
259
|
### Parameters
|
260
260
|
|
@@ -277,7 +277,7 @@ Name | Type | Description | Notes
|
|
277
277
|
|
278
278
|
<a name="put_mobiledevice"></a>
|
279
279
|
|
280
|
-
##
|
280
|
+
## [**UserDevice**](UserDevice.html) put_mobiledevice(device_id, opts)
|
281
281
|
|
282
282
|
|
283
283
|
|
@@ -292,7 +292,7 @@ Requires NO permissions:
|
|
292
292
|
|
293
293
|
|
294
294
|
### Example
|
295
|
-
|
295
|
+
```{"language":"ruby"}
|
296
296
|
# load the gem
|
297
297
|
require 'purecloudplatformclientv2'
|
298
298
|
# setup authorization
|
@@ -321,7 +321,7 @@ begin
|
|
321
321
|
rescue PureCloud::ApiError => e
|
322
322
|
puts "Exception when calling MobileDevicesApi->put_mobiledevice: #{e}"
|
323
323
|
end
|
324
|
-
|
324
|
+
```
|
325
325
|
|
326
326
|
### Parameters
|
327
327
|
|
data/docs/NotificationsApi.md
CHANGED
@@ -19,7 +19,7 @@ Method | Description
|
|
19
19
|
|
20
20
|
<a name="delete_notifications_channel_subscriptions"></a>
|
21
21
|
|
22
|
-
##
|
22
|
+
## delete_notifications_channel_subscriptions(channel_id)
|
23
23
|
|
24
24
|
|
25
25
|
|
@@ -34,7 +34,7 @@ Requires NO permissions:
|
|
34
34
|
|
35
35
|
|
36
36
|
### Example
|
37
|
-
|
37
|
+
```{"language":"ruby"}
|
38
38
|
# load the gem
|
39
39
|
require 'purecloudplatformclientv2'
|
40
40
|
# setup authorization
|
@@ -59,7 +59,7 @@ begin
|
|
59
59
|
rescue PureCloud::ApiError => e
|
60
60
|
puts "Exception when calling NotificationsApi->delete_notifications_channel_subscriptions: #{e}"
|
61
61
|
end
|
62
|
-
|
62
|
+
```
|
63
63
|
|
64
64
|
### Parameters
|
65
65
|
|
@@ -82,7 +82,7 @@ nil (empty response body)
|
|
82
82
|
|
83
83
|
<a name="get_notifications_availabletopics"></a>
|
84
84
|
|
85
|
-
##
|
85
|
+
## [**AvailableTopicEntityListing**](AvailableTopicEntityListing.html) get_notifications_availabletopics(opts)
|
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
|
@@ -124,7 +124,7 @@ begin
|
|
124
124
|
rescue PureCloud::ApiError => e
|
125
125
|
puts "Exception when calling NotificationsApi->get_notifications_availabletopics: #{e}"
|
126
126
|
end
|
127
|
-
|
127
|
+
```
|
128
128
|
|
129
129
|
### Parameters
|
130
130
|
|
@@ -147,7 +147,7 @@ Name | Type | Description | Notes
|
|
147
147
|
|
148
148
|
<a name="get_notifications_channel_subscriptions"></a>
|
149
149
|
|
150
|
-
##
|
150
|
+
## [**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) get_notifications_channel_subscriptions(channel_id)
|
151
151
|
|
152
152
|
|
153
153
|
|
@@ -162,7 +162,7 @@ Requires NO permissions:
|
|
162
162
|
|
163
163
|
|
164
164
|
### Example
|
165
|
-
|
165
|
+
```{"language":"ruby"}
|
166
166
|
# load the gem
|
167
167
|
require 'purecloudplatformclientv2'
|
168
168
|
# setup authorization
|
@@ -188,7 +188,7 @@ begin
|
|
188
188
|
rescue PureCloud::ApiError => e
|
189
189
|
puts "Exception when calling NotificationsApi->get_notifications_channel_subscriptions: #{e}"
|
190
190
|
end
|
191
|
-
|
191
|
+
```
|
192
192
|
|
193
193
|
### Parameters
|
194
194
|
|
@@ -211,7 +211,7 @@ Name | Type | Description | Notes
|
|
211
211
|
|
212
212
|
<a name="get_notifications_channels"></a>
|
213
213
|
|
214
|
-
##
|
214
|
+
## [**ChannelEntityListing**](ChannelEntityListing.html) get_notifications_channels(opts)
|
215
215
|
|
216
216
|
|
217
217
|
|
@@ -226,7 +226,7 @@ Requires NO permissions:
|
|
226
226
|
|
227
227
|
|
228
228
|
### Example
|
229
|
-
|
229
|
+
```{"language":"ruby"}
|
230
230
|
# load the gem
|
231
231
|
require 'purecloudplatformclientv2'
|
232
232
|
# setup authorization
|
@@ -253,7 +253,7 @@ begin
|
|
253
253
|
rescue PureCloud::ApiError => e
|
254
254
|
puts "Exception when calling NotificationsApi->get_notifications_channels: #{e}"
|
255
255
|
end
|
256
|
-
|
256
|
+
```
|
257
257
|
|
258
258
|
### Parameters
|
259
259
|
|
@@ -276,7 +276,7 @@ Name | Type | Description | Notes
|
|
276
276
|
|
277
277
|
<a name="post_notifications_channel_subscriptions"></a>
|
278
278
|
|
279
|
-
##
|
279
|
+
## [**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) post_notifications_channel_subscriptions(channel_id, body)
|
280
280
|
|
281
281
|
|
282
282
|
|
@@ -291,7 +291,7 @@ Requires NO permissions:
|
|
291
291
|
|
292
292
|
|
293
293
|
### Example
|
294
|
-
|
294
|
+
```{"language":"ruby"}
|
295
295
|
# load the gem
|
296
296
|
require 'purecloudplatformclientv2'
|
297
297
|
# setup authorization
|
@@ -319,7 +319,7 @@ begin
|
|
319
319
|
rescue PureCloud::ApiError => e
|
320
320
|
puts "Exception when calling NotificationsApi->post_notifications_channel_subscriptions: #{e}"
|
321
321
|
end
|
322
|
-
|
322
|
+
```
|
323
323
|
|
324
324
|
### Parameters
|
325
325
|
|
@@ -343,7 +343,7 @@ Name | Type | Description | Notes
|
|
343
343
|
|
344
344
|
<a name="post_notifications_channels"></a>
|
345
345
|
|
346
|
-
##
|
346
|
+
## [**Channel**](Channel.html) post_notifications_channels
|
347
347
|
|
348
348
|
|
349
349
|
|
@@ -358,7 +358,7 @@ Requires NO permissions:
|
|
358
358
|
|
359
359
|
|
360
360
|
### Example
|
361
|
-
|
361
|
+
```{"language":"ruby"}
|
362
362
|
# load the gem
|
363
363
|
require 'purecloudplatformclientv2'
|
364
364
|
# setup authorization
|
@@ -381,7 +381,7 @@ begin
|
|
381
381
|
rescue PureCloud::ApiError => e
|
382
382
|
puts "Exception when calling NotificationsApi->post_notifications_channels: #{e}"
|
383
383
|
end
|
384
|
-
|
384
|
+
```
|
385
385
|
|
386
386
|
### Parameters
|
387
387
|
This endpoint does not need any parameter.
|
@@ -401,7 +401,7 @@ This endpoint does not need any parameter.
|
|
401
401
|
|
402
402
|
<a name="put_notifications_channel_subscriptions"></a>
|
403
403
|
|
404
|
-
##
|
404
|
+
## [**ChannelTopicEntityListing**](ChannelTopicEntityListing.html) put_notifications_channel_subscriptions(channel_id, body)
|
405
405
|
|
406
406
|
|
407
407
|
|
@@ -416,7 +416,7 @@ Requires NO permissions:
|
|
416
416
|
|
417
417
|
|
418
418
|
### Example
|
419
|
-
|
419
|
+
```{"language":"ruby"}
|
420
420
|
# load the gem
|
421
421
|
require 'purecloudplatformclientv2'
|
422
422
|
# setup authorization
|
@@ -444,7 +444,7 @@ begin
|
|
444
444
|
rescue PureCloud::ApiError => e
|
445
445
|
puts "Exception when calling NotificationsApi->put_notifications_channel_subscriptions: #{e}"
|
446
446
|
end
|
447
|
-
|
447
|
+
```
|
448
448
|
|
449
449
|
### Parameters
|
450
450
|
|
data/docs/OAuthApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | Description
|
|
18
18
|
|
19
19
|
<a name="delete_oauth_client"></a>
|
20
20
|
|
21
|
-
##
|
21
|
+
## delete_oauth_client(client_id)
|
22
22
|
|
23
23
|
|
24
24
|
|
@@ -34,7 +34,7 @@ Requires ANY permissions:
|
|
34
34
|
|
35
35
|
|
36
36
|
### Example
|
37
|
-
|
37
|
+
```{"language":"ruby"}
|
38
38
|
# load the gem
|
39
39
|
require 'purecloudplatformclientv2'
|
40
40
|
# setup authorization
|
@@ -59,7 +59,7 @@ begin
|
|
59
59
|
rescue PureCloud::ApiError => e
|
60
60
|
puts "Exception when calling OAuthApi->delete_oauth_client: #{e}"
|
61
61
|
end
|
62
|
-
|
62
|
+
```
|
63
63
|
|
64
64
|
### Parameters
|
65
65
|
|
@@ -82,7 +82,7 @@ nil (empty response body)
|
|
82
82
|
|
83
83
|
<a name="get_oauth_client"></a>
|
84
84
|
|
85
|
-
##
|
85
|
+
## [**OAuthClient**](OAuthClient.html) get_oauth_client(client_id)
|
86
86
|
|
87
87
|
|
88
88
|
|
@@ -98,7 +98,7 @@ Requires ANY permissions:
|
|
98
98
|
|
99
99
|
|
100
100
|
### Example
|
101
|
-
|
101
|
+
```{"language":"ruby"}
|
102
102
|
# load the gem
|
103
103
|
require 'purecloudplatformclientv2'
|
104
104
|
# setup authorization
|
@@ -124,7 +124,7 @@ begin
|
|
124
124
|
rescue PureCloud::ApiError => e
|
125
125
|
puts "Exception when calling OAuthApi->get_oauth_client: #{e}"
|
126
126
|
end
|
127
|
-
|
127
|
+
```
|
128
128
|
|
129
129
|
### Parameters
|
130
130
|
|
@@ -147,7 +147,7 @@ Name | Type | Description | Notes
|
|
147
147
|
|
148
148
|
<a name="get_oauth_clients"></a>
|
149
149
|
|
150
|
-
##
|
150
|
+
## [**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_oauth_clients
|
151
151
|
|
152
152
|
|
153
153
|
|
@@ -163,7 +163,7 @@ Requires ANY permissions:
|
|
163
163
|
|
164
164
|
|
165
165
|
### Example
|
166
|
-
|
166
|
+
```{"language":"ruby"}
|
167
167
|
# load the gem
|
168
168
|
require 'purecloudplatformclientv2'
|
169
169
|
# setup authorization
|
@@ -186,7 +186,7 @@ begin
|
|
186
186
|
rescue PureCloud::ApiError => e
|
187
187
|
puts "Exception when calling OAuthApi->get_oauth_clients: #{e}"
|
188
188
|
end
|
189
|
-
|
189
|
+
```
|
190
190
|
|
191
191
|
### Parameters
|
192
192
|
This endpoint does not need any parameter.
|
@@ -206,7 +206,7 @@ This endpoint does not need any parameter.
|
|
206
206
|
|
207
207
|
<a name="post_oauth_client_secret"></a>
|
208
208
|
|
209
|
-
##
|
209
|
+
## [**OAuthClient**](OAuthClient.html) post_oauth_client_secret(client_id)
|
210
210
|
|
211
211
|
|
212
212
|
|
@@ -222,7 +222,7 @@ Requires ANY permissions:
|
|
222
222
|
|
223
223
|
|
224
224
|
### Example
|
225
|
-
|
225
|
+
```{"language":"ruby"}
|
226
226
|
# load the gem
|
227
227
|
require 'purecloudplatformclientv2'
|
228
228
|
# setup authorization
|
@@ -248,7 +248,7 @@ begin
|
|
248
248
|
rescue PureCloud::ApiError => e
|
249
249
|
puts "Exception when calling OAuthApi->post_oauth_client_secret: #{e}"
|
250
250
|
end
|
251
|
-
|
251
|
+
```
|
252
252
|
|
253
253
|
### Parameters
|
254
254
|
|
@@ -271,7 +271,7 @@ Name | Type | Description | Notes
|
|
271
271
|
|
272
272
|
<a name="post_oauth_clients"></a>
|
273
273
|
|
274
|
-
##
|
274
|
+
## [**OAuthClient**](OAuthClient.html) post_oauth_clients(body)
|
275
275
|
|
276
276
|
|
277
277
|
|
@@ -287,7 +287,7 @@ Requires ANY permissions:
|
|
287
287
|
|
288
288
|
|
289
289
|
### Example
|
290
|
-
|
290
|
+
```{"language":"ruby"}
|
291
291
|
# load the gem
|
292
292
|
require 'purecloudplatformclientv2'
|
293
293
|
# setup authorization
|
@@ -313,7 +313,7 @@ begin
|
|
313
313
|
rescue PureCloud::ApiError => e
|
314
314
|
puts "Exception when calling OAuthApi->post_oauth_clients: #{e}"
|
315
315
|
end
|
316
|
-
|
316
|
+
```
|
317
317
|
|
318
318
|
### Parameters
|
319
319
|
|
@@ -336,7 +336,7 @@ Name | Type | Description | Notes
|
|
336
336
|
|
337
337
|
<a name="put_oauth_client"></a>
|
338
338
|
|
339
|
-
##
|
339
|
+
## [**OAuthClient**](OAuthClient.html) put_oauth_client(client_id, body)
|
340
340
|
|
341
341
|
|
342
342
|
|
@@ -352,7 +352,7 @@ Requires ANY permissions:
|
|
352
352
|
|
353
353
|
|
354
354
|
### Example
|
355
|
-
|
355
|
+
```{"language":"ruby"}
|
356
356
|
# load the gem
|
357
357
|
require 'purecloudplatformclientv2'
|
358
358
|
# setup authorization
|
@@ -380,7 +380,7 @@ begin
|
|
380
380
|
rescue PureCloud::ApiError => e
|
381
381
|
puts "Exception when calling OAuthApi->put_oauth_client: #{e}"
|
382
382
|
end
|
383
|
-
|
383
|
+
```
|
384
384
|
|
385
385
|
### Parameters
|
386
386
|
|