docs/SearchApi.md in purecloudplatformclientv2-34.0.0 vs docs/SearchApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -26,17 +26,23 @@
<a name="get_documentation_search"></a>
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_documentation_search(q64)
+
+
Search documentation using the q64 value returned from a previous search
Wraps GET /api/v2/documentation/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -85,17 +91,23 @@
<a name="get_groups_search"></a>
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
+
+
Search groups using the q64 value returned from a previous search
Wraps GET /api/v2/groups/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -148,17 +160,23 @@
<a name="get_locations_search"></a>
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_locations_search(q64, opts)
+
+
Search locations using the q64 value returned from a previous search
Wraps GET /api/v2/locations/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -211,17 +229,23 @@
<a name="get_search"></a>
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
+
+
Search using the q64 value returned from a previous search.
Wraps GET /api/v2/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -276,17 +300,23 @@
<a name="get_search_suggest"></a>
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_suggest(q64, opts)
+
+
Suggest resources using the q64 value returned from a previous suggest query.
Wraps GET /api/v2/search/suggest
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -341,17 +371,23 @@
<a name="get_users_search"></a>
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
+
+
Search users using the q64 value returned from a previous search
Wraps GET /api/v2/users/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -404,17 +440,23 @@
<a name="get_voicemail_search"></a>
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
+
+
Search voicemails using the q64 value returned from a previous search
Wraps GET /api/v2/voicemail/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -467,17 +509,23 @@
<a name="post_documentation_search"></a>
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_documentation_search(body)
+
+
Search documentation
Wraps POST /api/v2/documentation/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -526,17 +574,23 @@
<a name="post_groups_search"></a>
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
+
+
Search groups
Wraps POST /api/v2/groups/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -585,17 +639,23 @@
<a name="post_locations_search"></a>
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)
+
+
Search locations
Wraps POST /api/v2/locations/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -644,17 +704,23 @@
<a name="post_search"></a>
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
+
+
Search resources.
Wraps POST /api/v2/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -707,17 +773,23 @@
<a name="post_search_suggest"></a>
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_suggest(body, opts)
+
+
Suggest resources.
Wraps POST /api/v2/search/suggest
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -770,17 +842,23 @@
<a name="post_users_search"></a>
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
+
+
Search users
Wraps POST /api/v2/users/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -829,14 +907,20 @@
<a name="post_voicemail_search"></a>
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
+
+
Search voicemails
Wraps POST /api/v2/voicemail/search
+
+Requires NO permissions:
+
+
### Example
~~~ruby
# load the gem