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/ScriptsApi.md
CHANGED
@@ -23,7 +23,7 @@ Method | Description
|
|
23
23
|
|
24
24
|
<a name="get_script"></a>
|
25
25
|
|
26
|
-
##
|
26
|
+
## [**Script**](Script.html) get_script(script_id)
|
27
27
|
|
28
28
|
|
29
29
|
|
@@ -39,7 +39,7 @@ Requires ANY permissions:
|
|
39
39
|
|
40
40
|
|
41
41
|
### Example
|
42
|
-
|
42
|
+
```{"language":"ruby"}
|
43
43
|
# load the gem
|
44
44
|
require 'purecloudplatformclientv2'
|
45
45
|
# setup authorization
|
@@ -65,7 +65,7 @@ begin
|
|
65
65
|
rescue PureCloud::ApiError => e
|
66
66
|
puts "Exception when calling ScriptsApi->get_script: #{e}"
|
67
67
|
end
|
68
|
-
|
68
|
+
```
|
69
69
|
|
70
70
|
### Parameters
|
71
71
|
|
@@ -88,7 +88,7 @@ Name | Type | Description | Notes
|
|
88
88
|
|
89
89
|
<a name="get_script_page"></a>
|
90
90
|
|
91
|
-
##
|
91
|
+
## [**Page**](Page.html) get_script_page(script_id, page_id, opts)
|
92
92
|
|
93
93
|
|
94
94
|
|
@@ -104,7 +104,7 @@ Requires ANY permissions:
|
|
104
104
|
|
105
105
|
|
106
106
|
### Example
|
107
|
-
|
107
|
+
```{"language":"ruby"}
|
108
108
|
# load the gem
|
109
109
|
require 'purecloudplatformclientv2'
|
110
110
|
# setup authorization
|
@@ -135,7 +135,7 @@ begin
|
|
135
135
|
rescue PureCloud::ApiError => e
|
136
136
|
puts "Exception when calling ScriptsApi->get_script_page: #{e}"
|
137
137
|
end
|
138
|
-
|
138
|
+
```
|
139
139
|
|
140
140
|
### Parameters
|
141
141
|
|
@@ -160,7 +160,7 @@ Name | Type | Description | Notes
|
|
160
160
|
|
161
161
|
<a name="get_script_pages"></a>
|
162
162
|
|
163
|
-
##
|
163
|
+
## [**Array<Page>**](Page.html) get_script_pages(script_id, opts)
|
164
164
|
|
165
165
|
|
166
166
|
|
@@ -176,7 +176,7 @@ Requires ANY permissions:
|
|
176
176
|
|
177
177
|
|
178
178
|
### Example
|
179
|
-
|
179
|
+
```{"language":"ruby"}
|
180
180
|
# load the gem
|
181
181
|
require 'purecloudplatformclientv2'
|
182
182
|
# setup authorization
|
@@ -205,7 +205,7 @@ begin
|
|
205
205
|
rescue PureCloud::ApiError => e
|
206
206
|
puts "Exception when calling ScriptsApi->get_script_pages: #{e}"
|
207
207
|
end
|
208
|
-
|
208
|
+
```
|
209
209
|
|
210
210
|
### Parameters
|
211
211
|
|
@@ -229,7 +229,7 @@ Name | Type | Description | Notes
|
|
229
229
|
|
230
230
|
<a name="get_scripts"></a>
|
231
231
|
|
232
|
-
##
|
232
|
+
## [**ScriptEntityListing**](ScriptEntityListing.html) get_scripts(opts)
|
233
233
|
|
234
234
|
|
235
235
|
|
@@ -245,7 +245,7 @@ Requires ANY permissions:
|
|
245
245
|
|
246
246
|
|
247
247
|
### Example
|
248
|
-
|
248
|
+
```{"language":"ruby"}
|
249
249
|
# load the gem
|
250
250
|
require 'purecloudplatformclientv2'
|
251
251
|
# setup authorization
|
@@ -280,7 +280,7 @@ begin
|
|
280
280
|
rescue PureCloud::ApiError => e
|
281
281
|
puts "Exception when calling ScriptsApi->get_scripts: #{e}"
|
282
282
|
end
|
283
|
-
|
283
|
+
```
|
284
284
|
|
285
285
|
### Parameters
|
286
286
|
|
@@ -311,7 +311,7 @@ Name | Type | Description | Notes
|
|
311
311
|
|
312
312
|
<a name="get_scripts_published"></a>
|
313
313
|
|
314
|
-
##
|
314
|
+
## [**ScriptEntityListing**](ScriptEntityListing.html) get_scripts_published(script_id, opts)
|
315
315
|
|
316
316
|
|
317
317
|
|
@@ -327,7 +327,7 @@ Requires ANY permissions:
|
|
327
327
|
|
328
328
|
|
329
329
|
### Example
|
330
|
-
|
330
|
+
```{"language":"ruby"}
|
331
331
|
# load the gem
|
332
332
|
require 'purecloudplatformclientv2'
|
333
333
|
# setup authorization
|
@@ -362,7 +362,7 @@ begin
|
|
362
362
|
rescue PureCloud::ApiError => e
|
363
363
|
puts "Exception when calling ScriptsApi->get_scripts_published: #{e}"
|
364
364
|
end
|
365
|
-
|
365
|
+
```
|
366
366
|
|
367
367
|
### Parameters
|
368
368
|
|
@@ -392,7 +392,7 @@ Name | Type | Description | Notes
|
|
392
392
|
|
393
393
|
<a name="get_scripts_published_script_id"></a>
|
394
394
|
|
395
|
-
##
|
395
|
+
## [**Script**](Script.html) get_scripts_published_script_id(script_id, opts)
|
396
396
|
|
397
397
|
|
398
398
|
|
@@ -408,7 +408,7 @@ Requires ANY permissions:
|
|
408
408
|
|
409
409
|
|
410
410
|
### Example
|
411
|
-
|
411
|
+
```{"language":"ruby"}
|
412
412
|
# load the gem
|
413
413
|
require 'purecloudplatformclientv2'
|
414
414
|
# setup authorization
|
@@ -437,7 +437,7 @@ begin
|
|
437
437
|
rescue PureCloud::ApiError => e
|
438
438
|
puts "Exception when calling ScriptsApi->get_scripts_published_script_id: #{e}"
|
439
439
|
end
|
440
|
-
|
440
|
+
```
|
441
441
|
|
442
442
|
### Parameters
|
443
443
|
|
@@ -461,7 +461,7 @@ Name | Type | Description | Notes
|
|
461
461
|
|
462
462
|
<a name="get_scripts_published_script_id_page"></a>
|
463
463
|
|
464
|
-
##
|
464
|
+
## [**Page**](Page.html) get_scripts_published_script_id_page(script_id, page_id, opts)
|
465
465
|
|
466
466
|
|
467
467
|
|
@@ -477,7 +477,7 @@ Requires ANY permissions:
|
|
477
477
|
|
478
478
|
|
479
479
|
### Example
|
480
|
-
|
480
|
+
```{"language":"ruby"}
|
481
481
|
# load the gem
|
482
482
|
require 'purecloudplatformclientv2'
|
483
483
|
# setup authorization
|
@@ -508,7 +508,7 @@ begin
|
|
508
508
|
rescue PureCloud::ApiError => e
|
509
509
|
puts "Exception when calling ScriptsApi->get_scripts_published_script_id_page: #{e}"
|
510
510
|
end
|
511
|
-
|
511
|
+
```
|
512
512
|
|
513
513
|
### Parameters
|
514
514
|
|
@@ -533,7 +533,7 @@ Name | Type | Description | Notes
|
|
533
533
|
|
534
534
|
<a name="get_scripts_published_script_id_pages"></a>
|
535
535
|
|
536
|
-
##
|
536
|
+
## [**Array<Page>**](Page.html) get_scripts_published_script_id_pages(script_id, opts)
|
537
537
|
|
538
538
|
|
539
539
|
|
@@ -549,7 +549,7 @@ Requires ANY permissions:
|
|
549
549
|
|
550
550
|
|
551
551
|
### Example
|
552
|
-
|
552
|
+
```{"language":"ruby"}
|
553
553
|
# load the gem
|
554
554
|
require 'purecloudplatformclientv2'
|
555
555
|
# setup authorization
|
@@ -578,7 +578,7 @@ begin
|
|
578
578
|
rescue PureCloud::ApiError => e
|
579
579
|
puts "Exception when calling ScriptsApi->get_scripts_published_script_id_pages: #{e}"
|
580
580
|
end
|
581
|
-
|
581
|
+
```
|
582
582
|
|
583
583
|
### Parameters
|
584
584
|
|
@@ -602,7 +602,7 @@ Name | Type | Description | Notes
|
|
602
602
|
|
603
603
|
<a name="get_scripts_published_script_id_variables"></a>
|
604
604
|
|
605
|
-
##
|
605
|
+
## Object** get_scripts_published_script_id_variables(script_id, opts)
|
606
606
|
|
607
607
|
|
608
608
|
|
@@ -618,7 +618,7 @@ Requires ANY permissions:
|
|
618
618
|
|
619
619
|
|
620
620
|
### Example
|
621
|
-
|
621
|
+
```{"language":"ruby"}
|
622
622
|
# load the gem
|
623
623
|
require 'purecloudplatformclientv2'
|
624
624
|
# setup authorization
|
@@ -650,7 +650,7 @@ begin
|
|
650
650
|
rescue PureCloud::ApiError => e
|
651
651
|
puts "Exception when calling ScriptsApi->get_scripts_published_script_id_variables: #{e}"
|
652
652
|
end
|
653
|
-
|
653
|
+
```
|
654
654
|
|
655
655
|
### Parameters
|
656
656
|
|
@@ -677,7 +677,7 @@ Name | Type | Description | Notes
|
|
677
677
|
|
678
678
|
<a name="get_scripts_upload_status"></a>
|
679
679
|
|
680
|
-
##
|
680
|
+
## [**ImportScriptStatusResponse**](ImportScriptStatusResponse.html) get_scripts_upload_status(upload_id, opts)
|
681
681
|
|
682
682
|
|
683
683
|
|
@@ -693,7 +693,7 @@ Requires ANY permissions:
|
|
693
693
|
|
694
694
|
|
695
695
|
### Example
|
696
|
-
|
696
|
+
```{"language":"ruby"}
|
697
697
|
# load the gem
|
698
698
|
require 'purecloudplatformclientv2'
|
699
699
|
# setup authorization
|
@@ -722,7 +722,7 @@ begin
|
|
722
722
|
rescue PureCloud::ApiError => e
|
723
723
|
puts "Exception when calling ScriptsApi->get_scripts_upload_status: #{e}"
|
724
724
|
end
|
725
|
-
|
725
|
+
```
|
726
726
|
|
727
727
|
### Parameters
|
728
728
|
|
@@ -746,7 +746,7 @@ Name | Type | Description | Notes
|
|
746
746
|
|
747
747
|
<a name="post_script_export"></a>
|
748
748
|
|
749
|
-
##
|
749
|
+
## [**ExportScriptResponse**](ExportScriptResponse.html) post_script_export(script_id, opts)
|
750
750
|
|
751
751
|
|
752
752
|
|
@@ -762,7 +762,7 @@ Requires ANY permissions:
|
|
762
762
|
|
763
763
|
|
764
764
|
### Example
|
765
|
-
|
765
|
+
```{"language":"ruby"}
|
766
766
|
# load the gem
|
767
767
|
require 'purecloudplatformclientv2'
|
768
768
|
# setup authorization
|
@@ -791,7 +791,7 @@ begin
|
|
791
791
|
rescue PureCloud::ApiError => e
|
792
792
|
puts "Exception when calling ScriptsApi->post_script_export: #{e}"
|
793
793
|
end
|
794
|
-
|
794
|
+
```
|
795
795
|
|
796
796
|
### Parameters
|
797
797
|
|
data/docs/SearchApi.md
CHANGED
@@ -28,7 +28,7 @@ Method | Description
|
|
28
28
|
|
29
29
|
<a name="get_documentation_gkn_search"></a>
|
30
30
|
|
31
|
-
##
|
31
|
+
## [**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) get_documentation_gkn_search(q64)
|
32
32
|
|
33
33
|
|
34
34
|
|
@@ -43,7 +43,7 @@ Requires NO permissions:
|
|
43
43
|
|
44
44
|
|
45
45
|
### Example
|
46
|
-
|
46
|
+
```{"language":"ruby"}
|
47
47
|
# load the gem
|
48
48
|
require 'purecloudplatformclientv2'
|
49
49
|
|
@@ -59,7 +59,7 @@ begin
|
|
59
59
|
rescue PureCloud::ApiError => e
|
60
60
|
puts "Exception when calling SearchApi->get_documentation_gkn_search: #{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_documentation_search"></a>
|
84
84
|
|
85
|
-
##
|
85
|
+
## [**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_documentation_search(q64)
|
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
|
|
@@ -113,7 +113,7 @@ begin
|
|
113
113
|
rescue PureCloud::ApiError => e
|
114
114
|
puts "Exception when calling SearchApi->get_documentation_search: #{e}"
|
115
115
|
end
|
116
|
-
|
116
|
+
```
|
117
117
|
|
118
118
|
### Parameters
|
119
119
|
|
@@ -136,7 +136,7 @@ Name | Type | Description | Notes
|
|
136
136
|
|
137
137
|
<a name="get_groups_search"></a>
|
138
138
|
|
139
|
-
##
|
139
|
+
## [**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
|
140
140
|
|
141
141
|
|
142
142
|
|
@@ -151,7 +151,7 @@ Requires NO permissions:
|
|
151
151
|
|
152
152
|
|
153
153
|
### Example
|
154
|
-
|
154
|
+
```{"language":"ruby"}
|
155
155
|
# load the gem
|
156
156
|
require 'purecloudplatformclientv2'
|
157
157
|
# setup authorization
|
@@ -180,7 +180,7 @@ begin
|
|
180
180
|
rescue PureCloud::ApiError => e
|
181
181
|
puts "Exception when calling SearchApi->get_groups_search: #{e}"
|
182
182
|
end
|
183
|
-
|
183
|
+
```
|
184
184
|
|
185
185
|
### Parameters
|
186
186
|
|
@@ -204,7 +204,7 @@ Name | Type | Description | Notes
|
|
204
204
|
|
205
205
|
<a name="get_locations_search"></a>
|
206
206
|
|
207
|
-
##
|
207
|
+
## [**LocationsSearchResponse**](LocationsSearchResponse.html) get_locations_search(q64, opts)
|
208
208
|
|
209
209
|
|
210
210
|
|
@@ -219,7 +219,7 @@ Requires NO permissions:
|
|
219
219
|
|
220
220
|
|
221
221
|
### Example
|
222
|
-
|
222
|
+
```{"language":"ruby"}
|
223
223
|
# load the gem
|
224
224
|
require 'purecloudplatformclientv2'
|
225
225
|
# setup authorization
|
@@ -248,7 +248,7 @@ begin
|
|
248
248
|
rescue PureCloud::ApiError => e
|
249
249
|
puts "Exception when calling SearchApi->get_locations_search: #{e}"
|
250
250
|
end
|
251
|
-
|
251
|
+
```
|
252
252
|
|
253
253
|
### Parameters
|
254
254
|
|
@@ -272,7 +272,7 @@ Name | Type | Description | Notes
|
|
272
272
|
|
273
273
|
<a name="get_search"></a>
|
274
274
|
|
275
|
-
##
|
275
|
+
## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
|
276
276
|
|
277
277
|
|
278
278
|
|
@@ -287,7 +287,7 @@ Requires NO 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
|
@@ -317,7 +317,7 @@ begin
|
|
317
317
|
rescue PureCloud::ApiError => e
|
318
318
|
puts "Exception when calling SearchApi->get_search: #{e}"
|
319
319
|
end
|
320
|
-
|
320
|
+
```
|
321
321
|
|
322
322
|
### Parameters
|
323
323
|
|
@@ -342,7 +342,7 @@ Name | Type | Description | Notes
|
|
342
342
|
|
343
343
|
<a name="get_search_suggest"></a>
|
344
344
|
|
345
|
-
##
|
345
|
+
## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_suggest(q64, opts)
|
346
346
|
|
347
347
|
|
348
348
|
|
@@ -357,7 +357,7 @@ Requires NO permissions:
|
|
357
357
|
|
358
358
|
|
359
359
|
### Example
|
360
|
-
|
360
|
+
```{"language":"ruby"}
|
361
361
|
# load the gem
|
362
362
|
require 'purecloudplatformclientv2'
|
363
363
|
# setup authorization
|
@@ -387,7 +387,7 @@ begin
|
|
387
387
|
rescue PureCloud::ApiError => e
|
388
388
|
puts "Exception when calling SearchApi->get_search_suggest: #{e}"
|
389
389
|
end
|
390
|
-
|
390
|
+
```
|
391
391
|
|
392
392
|
### Parameters
|
393
393
|
|
@@ -412,7 +412,7 @@ Name | Type | Description | Notes
|
|
412
412
|
|
413
413
|
<a name="get_users_search"></a>
|
414
414
|
|
415
|
-
##
|
415
|
+
## [**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
|
416
416
|
|
417
417
|
|
418
418
|
|
@@ -427,7 +427,7 @@ Requires NO permissions:
|
|
427
427
|
|
428
428
|
|
429
429
|
### Example
|
430
|
-
|
430
|
+
```{"language":"ruby"}
|
431
431
|
# load the gem
|
432
432
|
require 'purecloudplatformclientv2'
|
433
433
|
# setup authorization
|
@@ -456,7 +456,7 @@ begin
|
|
456
456
|
rescue PureCloud::ApiError => e
|
457
457
|
puts "Exception when calling SearchApi->get_users_search: #{e}"
|
458
458
|
end
|
459
|
-
|
459
|
+
```
|
460
460
|
|
461
461
|
### Parameters
|
462
462
|
|
@@ -480,7 +480,7 @@ Name | Type | Description | Notes
|
|
480
480
|
|
481
481
|
<a name="get_voicemail_search"></a>
|
482
482
|
|
483
|
-
##
|
483
|
+
## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
|
484
484
|
|
485
485
|
|
486
486
|
|
@@ -495,7 +495,7 @@ Requires NO permissions:
|
|
495
495
|
|
496
496
|
|
497
497
|
### Example
|
498
|
-
|
498
|
+
```{"language":"ruby"}
|
499
499
|
# load the gem
|
500
500
|
require 'purecloudplatformclientv2'
|
501
501
|
# setup authorization
|
@@ -524,7 +524,7 @@ begin
|
|
524
524
|
rescue PureCloud::ApiError => e
|
525
525
|
puts "Exception when calling SearchApi->get_voicemail_search: #{e}"
|
526
526
|
end
|
527
|
-
|
527
|
+
```
|
528
528
|
|
529
529
|
### Parameters
|
530
530
|
|
@@ -548,7 +548,7 @@ Name | Type | Description | Notes
|
|
548
548
|
|
549
549
|
<a name="post_documentation_gkn_search"></a>
|
550
550
|
|
551
|
-
##
|
551
|
+
## [**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) post_documentation_gkn_search(body)
|
552
552
|
|
553
553
|
|
554
554
|
|
@@ -563,7 +563,7 @@ Requires NO permissions:
|
|
563
563
|
|
564
564
|
|
565
565
|
### Example
|
566
|
-
|
566
|
+
```{"language":"ruby"}
|
567
567
|
# load the gem
|
568
568
|
require 'purecloudplatformclientv2'
|
569
569
|
|
@@ -579,7 +579,7 @@ begin
|
|
579
579
|
rescue PureCloud::ApiError => e
|
580
580
|
puts "Exception when calling SearchApi->post_documentation_gkn_search: #{e}"
|
581
581
|
end
|
582
|
-
|
582
|
+
```
|
583
583
|
|
584
584
|
### Parameters
|
585
585
|
|
@@ -602,7 +602,7 @@ Name | Type | Description | Notes
|
|
602
602
|
|
603
603
|
<a name="post_documentation_search"></a>
|
604
604
|
|
605
|
-
##
|
605
|
+
## [**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_documentation_search(body)
|
606
606
|
|
607
607
|
|
608
608
|
|
@@ -617,7 +617,7 @@ Requires NO permissions:
|
|
617
617
|
|
618
618
|
|
619
619
|
### Example
|
620
|
-
|
620
|
+
```{"language":"ruby"}
|
621
621
|
# load the gem
|
622
622
|
require 'purecloudplatformclientv2'
|
623
623
|
|
@@ -633,7 +633,7 @@ begin
|
|
633
633
|
rescue PureCloud::ApiError => e
|
634
634
|
puts "Exception when calling SearchApi->post_documentation_search: #{e}"
|
635
635
|
end
|
636
|
-
|
636
|
+
```
|
637
637
|
|
638
638
|
### Parameters
|
639
639
|
|
@@ -656,7 +656,7 @@ Name | Type | Description | Notes
|
|
656
656
|
|
657
657
|
<a name="post_groups_search"></a>
|
658
658
|
|
659
|
-
##
|
659
|
+
## [**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
|
660
660
|
|
661
661
|
|
662
662
|
|
@@ -671,7 +671,7 @@ Requires NO permissions:
|
|
671
671
|
|
672
672
|
|
673
673
|
### Example
|
674
|
-
|
674
|
+
```{"language":"ruby"}
|
675
675
|
# load the gem
|
676
676
|
require 'purecloudplatformclientv2'
|
677
677
|
# setup authorization
|
@@ -697,7 +697,7 @@ begin
|
|
697
697
|
rescue PureCloud::ApiError => e
|
698
698
|
puts "Exception when calling SearchApi->post_groups_search: #{e}"
|
699
699
|
end
|
700
|
-
|
700
|
+
```
|
701
701
|
|
702
702
|
### Parameters
|
703
703
|
|
@@ -720,7 +720,7 @@ Name | Type | Description | Notes
|
|
720
720
|
|
721
721
|
<a name="post_locations_search"></a>
|
722
722
|
|
723
|
-
##
|
723
|
+
## [**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)
|
724
724
|
|
725
725
|
|
726
726
|
|
@@ -735,7 +735,7 @@ Requires NO permissions:
|
|
735
735
|
|
736
736
|
|
737
737
|
### Example
|
738
|
-
|
738
|
+
```{"language":"ruby"}
|
739
739
|
# load the gem
|
740
740
|
require 'purecloudplatformclientv2'
|
741
741
|
# setup authorization
|
@@ -761,7 +761,7 @@ begin
|
|
761
761
|
rescue PureCloud::ApiError => e
|
762
762
|
puts "Exception when calling SearchApi->post_locations_search: #{e}"
|
763
763
|
end
|
764
|
-
|
764
|
+
```
|
765
765
|
|
766
766
|
### Parameters
|
767
767
|
|
@@ -784,7 +784,7 @@ Name | Type | Description | Notes
|
|
784
784
|
|
785
785
|
<a name="post_search"></a>
|
786
786
|
|
787
|
-
##
|
787
|
+
## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
|
788
788
|
|
789
789
|
|
790
790
|
|
@@ -799,7 +799,7 @@ Requires NO permissions:
|
|
799
799
|
|
800
800
|
|
801
801
|
### Example
|
802
|
-
|
802
|
+
```{"language":"ruby"}
|
803
803
|
# load the gem
|
804
804
|
require 'purecloudplatformclientv2'
|
805
805
|
# setup authorization
|
@@ -828,7 +828,7 @@ begin
|
|
828
828
|
rescue PureCloud::ApiError => e
|
829
829
|
puts "Exception when calling SearchApi->post_search: #{e}"
|
830
830
|
end
|
831
|
-
|
831
|
+
```
|
832
832
|
|
833
833
|
### Parameters
|
834
834
|
|
@@ -852,7 +852,7 @@ Name | Type | Description | Notes
|
|
852
852
|
|
853
853
|
<a name="post_search_suggest"></a>
|
854
854
|
|
855
|
-
##
|
855
|
+
## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_suggest(body, opts)
|
856
856
|
|
857
857
|
|
858
858
|
|
@@ -867,7 +867,7 @@ Requires NO permissions:
|
|
867
867
|
|
868
868
|
|
869
869
|
### Example
|
870
|
-
|
870
|
+
```{"language":"ruby"}
|
871
871
|
# load the gem
|
872
872
|
require 'purecloudplatformclientv2'
|
873
873
|
# setup authorization
|
@@ -896,7 +896,7 @@ begin
|
|
896
896
|
rescue PureCloud::ApiError => e
|
897
897
|
puts "Exception when calling SearchApi->post_search_suggest: #{e}"
|
898
898
|
end
|
899
|
-
|
899
|
+
```
|
900
900
|
|
901
901
|
### Parameters
|
902
902
|
|
@@ -920,7 +920,7 @@ Name | Type | Description | Notes
|
|
920
920
|
|
921
921
|
<a name="post_users_search"></a>
|
922
922
|
|
923
|
-
##
|
923
|
+
## [**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
|
924
924
|
|
925
925
|
|
926
926
|
|
@@ -935,7 +935,7 @@ Requires NO permissions:
|
|
935
935
|
|
936
936
|
|
937
937
|
### Example
|
938
|
-
|
938
|
+
```{"language":"ruby"}
|
939
939
|
# load the gem
|
940
940
|
require 'purecloudplatformclientv2'
|
941
941
|
# setup authorization
|
@@ -961,7 +961,7 @@ begin
|
|
961
961
|
rescue PureCloud::ApiError => e
|
962
962
|
puts "Exception when calling SearchApi->post_users_search: #{e}"
|
963
963
|
end
|
964
|
-
|
964
|
+
```
|
965
965
|
|
966
966
|
### Parameters
|
967
967
|
|
@@ -984,7 +984,7 @@ Name | Type | Description | Notes
|
|
984
984
|
|
985
985
|
<a name="post_voicemail_search"></a>
|
986
986
|
|
987
|
-
##
|
987
|
+
## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
|
988
988
|
|
989
989
|
|
990
990
|
|
@@ -999,7 +999,7 @@ Requires NO permissions:
|
|
999
999
|
|
1000
1000
|
|
1001
1001
|
### Example
|
1002
|
-
|
1002
|
+
```{"language":"ruby"}
|
1003
1003
|
# load the gem
|
1004
1004
|
require 'purecloudplatformclientv2'
|
1005
1005
|
# setup authorization
|
@@ -1025,7 +1025,7 @@ begin
|
|
1025
1025
|
rescue PureCloud::ApiError => e
|
1026
1026
|
puts "Exception when calling SearchApi->post_voicemail_search: #{e}"
|
1027
1027
|
end
|
1028
|
-
|
1028
|
+
```
|
1029
1029
|
|
1030
1030
|
### Parameters
|
1031
1031
|
|