purecloud 0.37.1 → 0.38.1

data/doc_out/SearchApi.html.md

@@ -9,11 +9,15 @@ All URIs are relative to *https://api.mypurecloud.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 |[**get_search**](SearchApi.html#get_search) | **GET** /api/v2/groups/search | Search using q64|
-|[**get_search_0**](SearchApi.html#get_search_0) | **GET** /api/v2/search | Search using q64|
-|[**get_search_1**](SearchApi.html#get_search_1) | **GET** /api/v2/users/search | Search using q64|
+|[**get_search_0**](SearchApi.html#get_search_0) | **GET** /api/v2/locations/search | Search using q64|
+|[**get_search_1**](SearchApi.html#get_search_1) | **GET** /api/v2/search | Search using q64|
+|[**get_search_2**](SearchApi.html#get_search_2) | **GET** /api/v2/users/search | Search using q64|
+|[**get_suggest**](SearchApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest using q64|
 |[**post_search**](SearchApi.html#post_search) | **POST** /api/v2/groups/search | Search|
-|[**post_search_0**](SearchApi.html#post_search_0) | **POST** /api/v2/search | Search|
-|[**post_search_1**](SearchApi.html#post_search_1) | **POST** /api/v2/users/search | Search|
+|[**post_search_0**](SearchApi.html#post_search_0) | **POST** /api/v2/locations/search | Search|
+|[**post_search_1**](SearchApi.html#post_search_1) | **POST** /api/v2/search | Search|
+|[**post_search_2**](SearchApi.html#post_search_2) | **POST** /api/v2/users/search | Search|
+|[**post_suggest**](SearchApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest|
 {: class="table table-striped"}
 
 <a name="get_search"></a>
@@ -77,7 +81,7 @@ Name | Type | Description  | Notes
 
 <a name="get_search_0"></a>
 
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_0(opts)
+## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_search_0(opts)
 
 Search using q64
 
@@ -125,7 +129,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+[**GroupsSearchResponse**](GroupsSearchResponse.html)
 
 ### HTTP request headers
 
@@ -136,7 +140,7 @@ Name | Type | Description  | Notes
 
 <a name="get_search_1"></a>
 
-## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search_1(opts)
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_1(opts)
 
 Search using q64
 
@@ -161,7 +165,8 @@ api_instance = PureCloud::SearchApi.new
 
 opts = { 
   q64: "q64_example", # String | 
-  expand: ["expand_example"] # Array<String> | 
+  expand: ["expand_example"], # Array<String> | 
+  profile: true # BOOLEAN | 
 }
 
 begin
@@ -175,6 +180,66 @@ end
 
 ### Parameters
 
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q64** | **String**|  | [optional] 
+ **expand** | [**Array&lt;String&gt;**](String.html)|  | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_search_2"></a>
+
+## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search_2(opts)
+
+Search using q64
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SearchApi.new
+
+opts = { 
+  q64: "q64_example", # String | 
+  expand: ["expand_example"] # Array<String> | 
+}
+
+begin
+  #Search using q64
+  result = api_instance.get_search_2(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SearchApi->get_search_2: #{e}"
+end
+~~~
+
+### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q64** | **String**|  | [optional] 
@@ -193,6 +258,65 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_suggest"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_suggest(opts)
+
+Suggest using q64
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SearchApi.new
+
+opts = { 
+  q64: "q64_example", # String | 
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Suggest using q64
+  result = api_instance.get_suggest(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SearchApi->get_suggest: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q64** | **String**|  | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_search"></a>
 
 ## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_search(opts)
@@ -252,7 +376,7 @@ Name | Type | Description  | Notes
 
 <a name="post_search_0"></a>
 
-## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_0(opts)
+## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_search_0(opts)
 
 Search
 
@@ -298,7 +422,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+[**GroupsSearchResponse**](GroupsSearchResponse.html)
 
 ### HTTP request headers
 
@@ -309,7 +433,7 @@ Name | Type | Description  | Notes
 
 <a name="post_search_1"></a>
 
-## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search_1(opts)
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_1(opts)
 
 Search
 
@@ -333,7 +457,8 @@ end
 api_instance = PureCloud::SearchApi.new
 
 opts = { 
-  body: PureCloud::SearchRequest.new # SearchRequest | Search request options
+  body: PureCloud::SearchRequest.new, # SearchRequest | Search request options
+  profile: true # BOOLEAN | 
 }
 
 begin
@@ -347,6 +472,64 @@ end
 
 ### Parameters
 
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_search_2"></a>
+
+## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search_2(opts)
+
+Search
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SearchApi.new
+
+opts = { 
+  body: PureCloud::SearchRequest.new # SearchRequest | Search request options
+}
+
+begin
+  #Search
+  result = api_instance.post_search_2(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SearchApi->post_search_2: #{e}"
+end
+~~~
+
+### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
@@ -364,3 +547,62 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_suggest"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_suggest(opts)
+
+Suggest
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SearchApi.new
+
+opts = { 
+  body: PureCloud::SearchRequest.new, # SearchRequest | Search request options
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Suggest
+  result = api_instance.post_suggest(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SearchApi->post_suggest: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/doc_out/SuggestApi.html.md

@@ -0,0 +1,254 @@
+---
+title: SuggestApi
+---
+
+## PureCloud::SuggestApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+|[**get_search**](SuggestApi.html#get_search) | **GET** /api/v2/search | Search using q64|
+|[**get_suggest**](SuggestApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest using q64|
+|[**post_search**](SuggestApi.html#post_search) | **POST** /api/v2/search | Search|
+|[**post_suggest**](SuggestApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest|
+{: class="table table-striped"}
+
+<a name="get_search"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search(opts)
+
+Search using q64
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SuggestApi.new
+
+opts = { 
+  q64: "q64_example", # String | 
+  expand: ["expand_example"], # Array<String> | 
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Search using q64
+  result = api_instance.get_search(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SuggestApi->get_search: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q64** | **String**|  | [optional] 
+ **expand** | [**Array&lt;String&gt;**](String.html)|  | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_suggest"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_suggest(opts)
+
+Suggest using q64
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SuggestApi.new
+
+opts = { 
+  q64: "q64_example", # String | 
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Suggest using q64
+  result = api_instance.get_suggest(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SuggestApi->get_suggest: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q64** | **String**|  | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_search"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search(opts)
+
+Search
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SuggestApi.new
+
+opts = { 
+  body: PureCloud::SearchRequest.new, # SearchRequest | Search request options
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Search
+  result = api_instance.post_search(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SuggestApi->post_search: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_suggest"></a>
+
+## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_suggest(opts)
+
+Suggest
+
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::SuggestApi.new
+
+opts = { 
+  body: PureCloud::SearchRequest.new, # SearchRequest | Search request options
+  profile: true # BOOLEAN | 
+}
+
+begin
+  #Suggest
+  result = api_instance.post_suggest(opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SuggestApi->post_suggest: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional] 
+ **profile** | **BOOLEAN**|  | [optional] [default to true]
+{: class="table table-striped"}
+
+
+### Return type
+
+[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+