docs/WebChatApi.md in purecloudplatformclientv2-49.0.0 vs docs/WebChatApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -18,11 +18,11 @@
[**put_webchat_settings**](WebChatApi.html#put_webchat_settings) | Update WebChat deployment settings
{: class="table table-striped"}
<a name="delete_webchat_deployment"></a>
-## - delete_webchat_deployment(deployment_id)
+## delete_webchat_deployment(deployment_id)
Delete a WebChat deployment
@@ -34,11 +34,11 @@
* webchat:deployment:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -59,11 +59,11 @@
#Delete a WebChat deployment
api_instance.delete_webchat_deployment(deployment_id)
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->delete_webchat_deployment: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -82,11 +82,11 @@
<a name="delete_webchat_settings"></a>
-## - delete_webchat_settings
+## delete_webchat_settings
Remove WebChat deployment settings
@@ -98,11 +98,11 @@
* webchat:deployment:delete
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -120,11 +120,11 @@
#Remove WebChat deployment settings
api_instance.delete_webchat_settings
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->delete_webchat_settings: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -140,11 +140,11 @@
<a name="get_webchat_deployment"></a>
-## -[**WebChatDeployment**](WebChatDeployment.html) get_webchat_deployment(deployment_id)
+## [**WebChatDeployment**](WebChatDeployment.html) get_webchat_deployment(deployment_id)
Get a WebChat deployment
@@ -156,11 +156,11 @@
* webchat:deployment:read
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -182,11 +182,11 @@
result = api_instance.get_webchat_deployment(deployment_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->get_webchat_deployment: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -205,11 +205,11 @@
<a name="get_webchat_deployments"></a>
-## -[**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html) get_webchat_deployments
+## [**WebChatDeploymentEntityListing**](WebChatDeploymentEntityListing.html) get_webchat_deployments
List WebChat deployments
@@ -221,11 +221,11 @@
* webchat:deployment:read
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -244,11 +244,11 @@
result = api_instance.get_webchat_deployments
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->get_webchat_deployments: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -264,11 +264,11 @@
<a name="get_webchat_settings"></a>
-## -[**WebChatSettings**](WebChatSettings.html) get_webchat_settings
+## [**WebChatSettings**](WebChatSettings.html) get_webchat_settings
Get WebChat deployment settings
@@ -280,11 +280,11 @@
* webchat:deployment:read
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -303,11 +303,11 @@
result = api_instance.get_webchat_settings
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->get_webchat_settings: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -323,11 +323,11 @@
<a name="post_webchat_deployments"></a>
-## -[**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
+## [**WebChatDeployment**](WebChatDeployment.html) post_webchat_deployments(body)
Create WebChat deployment
@@ -339,11 +339,11 @@
* webchat:deployment:create
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -365,11 +365,11 @@
result = api_instance.post_webchat_deployments(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->post_webchat_deployments: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -388,11 +388,11 @@
<a name="put_webchat_deployment"></a>
-## -[**WebChatDeployment**](WebChatDeployment.html) put_webchat_deployment(deployment_id, body)
+## [**WebChatDeployment**](WebChatDeployment.html) put_webchat_deployment(deployment_id, body)
Update a WebChat deployment
@@ -404,11 +404,11 @@
* webchat:deployment:update
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -432,11 +432,11 @@
result = api_instance.put_webchat_deployment(deployment_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->put_webchat_deployment: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -456,11 +456,11 @@
<a name="put_webchat_settings"></a>
-## -[**WebChatSettings**](WebChatSettings.html) put_webchat_settings(body)
+## [**WebChatSettings**](WebChatSettings.html) put_webchat_settings(body)
Update WebChat deployment settings
@@ -472,11 +472,11 @@
* webchat:deployment:update
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -498,10 +498,10 @@
result = api_instance.put_webchat_settings(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling WebChatApi->put_webchat_settings: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------