docs/SearchApi.md in purecloudplatformclientv2-49.0.0 vs docs/SearchApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -26,11 +26,11 @@
[**post_voicemail_search**](SearchApi.html#post_voicemail_search) | Search voicemails
{: class="table table-striped"}
<a name="get_documentation_gkn_search"></a>
-## -[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) get_documentation_gkn_search(q64)
+## [**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) get_documentation_gkn_search(q64)
Search gkn documentation using the q64 value returned from a previous search
@@ -41,11 +41,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
api_instance = PureCloud::SearchApi.new
@@ -57,11 +57,11 @@
result = api_instance.get_documentation_gkn_search(q64)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_documentation_gkn_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -80,11 +80,11 @@
<a name="get_documentation_search"></a>
-## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_documentation_search(q64)
+## [**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_documentation_search(q64)
Search documentation using the q64 value returned from a previous search
@@ -95,11 +95,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
api_instance = PureCloud::SearchApi.new
@@ -111,11 +111,11 @@
result = api_instance.get_documentation_search(q64)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_documentation_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -134,11 +134,11 @@
<a name="get_groups_search"></a>
-## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
+## [**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
Search groups using the q64 value returned from a previous search
@@ -149,11 +149,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -178,11 +178,11 @@
result = api_instance.get_groups_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_groups_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -202,11 +202,11 @@
<a name="get_locations_search"></a>
-## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_locations_search(q64, opts)
+## [**LocationsSearchResponse**](LocationsSearchResponse.html) get_locations_search(q64, opts)
Search locations using the q64 value returned from a previous search
@@ -217,11 +217,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -246,11 +246,11 @@
result = api_instance.get_locations_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_locations_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -270,11 +270,11 @@
<a name="get_search"></a>
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
+## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(q64, opts)
Search using the q64 value returned from a previous search.
@@ -285,11 +285,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -315,11 +315,11 @@
result = api_instance.get_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -340,11 +340,11 @@
<a name="get_search_suggest"></a>
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_suggest(q64, opts)
+## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_suggest(q64, opts)
Suggest resources using the q64 value returned from a previous suggest query.
@@ -355,11 +355,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -385,11 +385,11 @@
result = api_instance.get_search_suggest(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_search_suggest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -410,11 +410,11 @@
<a name="get_users_search"></a>
-## -[**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
+## [**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
Search users using the q64 value returned from a previous search
@@ -425,11 +425,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -454,11 +454,11 @@
result = api_instance.get_users_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_users_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -478,11 +478,11 @@
<a name="get_voicemail_search"></a>
-## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
+## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
Search voicemails using the q64 value returned from a previous search
@@ -493,11 +493,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -522,11 +522,11 @@
result = api_instance.get_voicemail_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->get_voicemail_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -546,11 +546,11 @@
<a name="post_documentation_gkn_search"></a>
-## -[**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) post_documentation_gkn_search(body)
+## [**GKNDocumentationSearchResponse**](GKNDocumentationSearchResponse.html) post_documentation_gkn_search(body)
Search gkn documentation
@@ -561,11 +561,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
api_instance = PureCloud::SearchApi.new
@@ -577,11 +577,11 @@
result = api_instance.post_documentation_gkn_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_documentation_gkn_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -600,11 +600,11 @@
<a name="post_documentation_search"></a>
-## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_documentation_search(body)
+## [**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_documentation_search(body)
Search documentation
@@ -615,11 +615,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
api_instance = PureCloud::SearchApi.new
@@ -631,11 +631,11 @@
result = api_instance.post_documentation_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_documentation_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -654,11 +654,11 @@
<a name="post_groups_search"></a>
-## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
+## [**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
Search groups
@@ -669,11 +669,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -695,11 +695,11 @@
result = api_instance.post_groups_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_groups_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -718,11 +718,11 @@
<a name="post_locations_search"></a>
-## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)
+## [**LocationsSearchResponse**](LocationsSearchResponse.html) post_locations_search(body)
Search locations
@@ -733,11 +733,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -759,11 +759,11 @@
result = api_instance.post_locations_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_locations_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -782,11 +782,11 @@
<a name="post_search"></a>
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
+## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(body, opts)
Search resources.
@@ -797,11 +797,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -826,11 +826,11 @@
result = api_instance.post_search(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -850,11 +850,11 @@
<a name="post_search_suggest"></a>
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_suggest(body, opts)
+## [**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_suggest(body, opts)
Suggest resources.
@@ -865,11 +865,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -894,11 +894,11 @@
result = api_instance.post_search_suggest(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_search_suggest: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -918,11 +918,11 @@
<a name="post_users_search"></a>
-## -[**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
+## [**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
Search users
@@ -933,11 +933,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -959,11 +959,11 @@
result = api_instance.post_users_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_users_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -982,11 +982,11 @@
<a name="post_voicemail_search"></a>
-## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
+## [**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_voicemail_search(body)
Search voicemails
@@ -997,11 +997,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1023,10 +1023,10 @@
result = api_instance.post_voicemail_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling SearchApi->post_voicemail_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------