purecloudplatformclientv2 91.0.0 → 92.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AmazonLexRequest.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AuditApi.md +70 -0
- data/docs/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/ButtonComponent.md +16 -0
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/EdgeGroup.md +1 -0
- data/docs/EntityListing.md +1 -5
- data/docs/GoogleDialogflowCustomSettings.md +13 -0
- data/docs/LanguageUnderstandingApi.md +164 -30
- data/docs/ListItemComponent.md +19 -0
- data/docs/MessageContent.md +19 -0
- data/docs/NluDomainVersion.md +2 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/SurveyForm.md +0 -2
- data/docs/TextbotsApi.md +78 -0
- data/lib/purecloudplatformclientv2.rb +22 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
- data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
- data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +46 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: de5b34b200b5833072135f588c7cb1c5f5bbe4b5
|
4
|
+
data.tar.gz: eaee9307038e485bd8bd4cceb89b103cb68e03af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb4d0ac120ede979ec0a76dfdefbcb139915c0d31581e5778f2fee6f0593e3f080235c9dfa7f7972ac8e8fe37bbb06a4b95b960f5d463d431f10cc456d36d726
|
7
|
+
data.tar.gz: 5cfc3bb03f0ca0dc0de84d344c7b83f1735c1fde75daaf45ac0a32835782d3de6507fa79296315b548ddce15f92305c8d825757ebe53f595d97225e5b714a9f7
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: Platform API Client SDK - Ruby
|
3
3
|
---
|
4
|
-
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=
|
4
|
+
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=92.0.0)
|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 92.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: AmazonLexRequest
|
3
|
+
---
|
4
|
+
## PureCloud::AmazonLexRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **request_attributes** | **Hash<String, String>** | AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs | [optional] |
|
11
|
+
| **session_attributes** | **Hash<String, String>** | AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/docs/AnalyticsEvaluation.md
CHANGED
@@ -18,8 +18,8 @@ title: AnalyticsEvaluation
|
|
18
18
|
| **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
|
19
19
|
| **rescored** | **BOOLEAN** | Whether this evaluation has ever been rescored | [optional] |
|
20
20
|
| **deleted** | **BOOLEAN** | Whether this evaluation has been deleted | [optional] |
|
21
|
-
| **o_total_score** | **Integer** | | [optional] |
|
22
21
|
| **o_total_critical_score** | **Integer** | | [optional] |
|
22
|
+
| **o_total_score** | **Integer** | | [optional] |
|
23
23
|
{: class="table table-striped"}
|
24
24
|
|
25
25
|
|
data/docs/AuditApi.md
CHANGED
@@ -12,6 +12,7 @@ Method | Description
|
|
12
12
|
[**get_audits_query_transaction_id**](AuditApi.html#get_audits_query_transaction_id) | Get status of audit query execution
|
13
13
|
[**get_audits_query_transaction_id_results**](AuditApi.html#get_audits_query_transaction_id_results) | Get results of audit query
|
14
14
|
[**post_audits_query**](AuditApi.html#post_audits_query) | Create audit query execution
|
15
|
+
[**post_audits_query_realtime**](AuditApi.html#post_audits_query_realtime) | This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
15
16
|
{: class="table table-striped"}
|
16
17
|
|
17
18
|
<a name="get_audits_query_servicemapping"></a>
|
@@ -276,3 +277,72 @@ Name | Type | Description | Notes
|
|
276
277
|
|
277
278
|
|
278
279
|
|
280
|
+
<a name="post_audits_query_realtime"></a>
|
281
|
+
|
282
|
+
## [**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html) post_audits_query_realtime(body, opts)
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
Wraps POST /api/v2/audits/query/realtime
|
291
|
+
|
292
|
+
Requires ALL permissions:
|
293
|
+
|
294
|
+
* audits:audit:view
|
295
|
+
|
296
|
+
|
297
|
+
### Example
|
298
|
+
```{"language":"ruby"}
|
299
|
+
# load the gem
|
300
|
+
require 'purecloudplatformclientv2'
|
301
|
+
# setup authorization
|
302
|
+
@secret = ENV['PURECLOUD_SECRET']
|
303
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
304
|
+
environment = "mypurecloud.com"
|
305
|
+
|
306
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
307
|
+
|
308
|
+
PureCloud.configure do |config|
|
309
|
+
config.access_token = @authToken
|
310
|
+
end
|
311
|
+
|
312
|
+
api_instance = PureCloud::AuditApi.new
|
313
|
+
|
314
|
+
body = PureCloud::AuditRealtimeQueryRequest.new # AuditRealtimeQueryRequest | query
|
315
|
+
|
316
|
+
opts = {
|
317
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
318
|
+
}
|
319
|
+
|
320
|
+
begin
|
321
|
+
#This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
322
|
+
result = api_instance.post_audits_query_realtime(body, opts)
|
323
|
+
p result
|
324
|
+
rescue PureCloud::ApiError => e
|
325
|
+
puts "Exception when calling AuditApi->post_audits_query_realtime: #{e}"
|
326
|
+
end
|
327
|
+
```
|
328
|
+
|
329
|
+
### Parameters
|
330
|
+
|
331
|
+
Name | Type | Description | Notes
|
332
|
+
------------- | ------------- | ------------- | -------------
|
333
|
+
**body** | [**AuditRealtimeQueryRequest**](AuditRealtimeQueryRequest.html)| query | |
|
334
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: user |
|
335
|
+
{: class="table table-striped"}
|
336
|
+
|
337
|
+
|
338
|
+
### Return type
|
339
|
+
|
340
|
+
[**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html)
|
341
|
+
|
342
|
+
### HTTP request headers
|
343
|
+
|
344
|
+
- **Content-Type**: application/json
|
345
|
+
- **Accept**: application/json
|
346
|
+
|
347
|
+
|
348
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
---
|
2
|
+
title: AuditRealtimeQueryRequest
|
3
|
+
---
|
4
|
+
## PureCloud::AuditRealtimeQueryRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **interval** | **String** | Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
|
+
| **service_name** | **String** | Name of the service to query audits for. | |
|
12
|
+
| **filters** | [**Array<AuditQueryFilter>**](AuditQueryFilter.html) | Additional filters for the query. | [optional] |
|
13
|
+
| **sort** | [**Array<AuditQuerySort>**](AuditQuerySort.html) | Sort parameter for the query. | [optional] |
|
14
|
+
| **page_number** | **Integer** | Page number | [optional] |
|
15
|
+
| **page_size** | **Integer** | Page size | [optional] |
|
16
|
+
{: class="table table-striped"}
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: AuditRealtimeQueryResultsResponse
|
3
|
+
---
|
4
|
+
## PureCloud::AuditRealtimeQueryResultsResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<AuditLogMessage>**](AuditLogMessage.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **page_count** | **Integer** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: ButtonComponent
|
3
|
+
---
|
4
|
+
## PureCloud::ButtonComponent
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | An ID assigned to this component | [optional] |
|
11
|
+
| **text** | **String** | Text to show inside the button | [optional] |
|
12
|
+
| **title** | **String** | Tooltip text to show when hovering over the button | [optional] |
|
13
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ContentActions
|
3
|
+
---
|
4
|
+
## PureCloud::ContentActions
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **url** | **String** | A URL for a web page to redirect the user to | [optional] |
|
11
|
+
| **url_target** | **String** | The target window or tab within the URL's web page. If empty will open a blank page or tab. | [optional] |
|
12
|
+
| **textback** | **String** | Text to be sent back in reply when a list item is selected | [optional] |
|
13
|
+
| **command_name** | **String** | Execute an organization's specific command | [optional] |
|
14
|
+
| **context** | **Hash<String, Object>** | Additional context for the command | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: ContentAttachment
|
3
|
+
---
|
4
|
+
## PureCloud::ContentAttachment
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | Vendor specific ID for media. For example, a LINE sticker ID | [optional] |
|
11
|
+
| **media_type** | **String** | The type of media this instance represents | |
|
12
|
+
| **url** | **String** | Content element url | [optional] |
|
13
|
+
| **mime** | **String** | Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml | [optional] |
|
14
|
+
| **text** | **String** | Text message associated with media element: e.g. caption in case of image. | [optional] |
|
15
|
+
| **sha256** | **String** | Secure hash of the media content | [optional] |
|
16
|
+
| **filename** | **String** | Suggested file name for media file | [optional] |
|
17
|
+
{: class="table table-striped"}
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: ContentGeneric
|
3
|
+
---
|
4
|
+
## PureCloud::ContentGeneric
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | An ID assigned to this rich message content. Each instance inside the content array has a unique ID. | [optional] |
|
11
|
+
| **title** | **String** | Text to show in the title row | [optional] |
|
12
|
+
| **description** | **String** | Text to show in the description row. This is immediately below the title | [optional] |
|
13
|
+
| **image** | **String** | Path or URI to an image file | [optional] |
|
14
|
+
| **video** | **String** | Path or URI to a video file | [optional] |
|
15
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
16
|
+
| **components** | [**Array<ButtonComponent>**](ButtonComponent.html) | An array of component objects | [optional] |
|
17
|
+
{: class="table table-striped"}
|
18
|
+
|
19
|
+
|
data/docs/ContentList.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
---
|
2
|
+
title: ContentList
|
3
|
+
---
|
4
|
+
## PureCloud::ContentList
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | An ID assigned to this rich message content. Each instance inside the content array has a unique ID. | [optional] |
|
11
|
+
| **list_type** | **String** | The type of list this instance represents | [optional] |
|
12
|
+
| **title** | **String** | Text to show in the title row | [optional] |
|
13
|
+
| **description** | **String** | Text to show in the description row. This is immediately below the title | [optional] |
|
14
|
+
| **submit_label** | **String** | Label for Submit button | [optional] |
|
15
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
16
|
+
| **components** | [**Array<ListItemComponent>**](ListItemComponent.html) | An array of component objects | [optional] |
|
17
|
+
{: class="table table-striped"}
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ContentLocation
|
3
|
+
---
|
4
|
+
## PureCloud::ContentLocation
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **url** | **String** | Location map url | [optional] |
|
11
|
+
| **address** | **String** | Location postal address | [optional] |
|
12
|
+
| **text** | **String** | Location name | [optional] |
|
13
|
+
| **latitude** | **Float** | Latitude of the location | [optional] |
|
14
|
+
| **longitude** | **Float** | Longitude of the location | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ContentNotificationTemplate
|
3
|
+
---
|
4
|
+
## PureCloud::ContentNotificationTemplate
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The messaging channel template id. For WhatsApp, 'namespace@name' | [optional] |
|
11
|
+
| **language** | **String** | Template language | [optional] |
|
12
|
+
| **header** | [**NotificationTemplateHeader**](NotificationTemplateHeader.html) | Template header object | [optional] |
|
13
|
+
| **body** | [**NotificationTemplateBody**](NotificationTemplateBody.html) | Template body object | |
|
14
|
+
| **footer** | [**NotificationTemplateFooter**](NotificationTemplateFooter.html) | Template footer object | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: ContentQuickReply
|
3
|
+
---
|
4
|
+
## PureCloud::ContentQuickReply
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | An ID assigned to the quick reply. Each object inside the content array has a unique ID. | [optional] |
|
11
|
+
| **text** | **String** | Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply. | |
|
12
|
+
| **image** | **String** | Image associated with quick reply | [optional] |
|
13
|
+
| **action** | **String** | Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text. | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
data/docs/EdgeGroup.md
CHANGED
@@ -19,6 +19,7 @@ title: EdgeGroup
|
|
19
19
|
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
20
20
|
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
21
21
|
| **managed** | **BOOLEAN** | Is this edge group being managed remotely. | [optional] |
|
22
|
+
| **hybrid** | **BOOLEAN** | Is this edge group hybrid. | [optional] |
|
22
23
|
| **edge_trunk_base_assignment** | [**TrunkBaseAssignment**](TrunkBaseAssignment.html) | A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication. | |
|
23
24
|
| **phone_trunk_bases** | [**Array<TrunkBase>**](TrunkBase.html) | Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication. | |
|
24
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
data/docs/EntityListing.md
CHANGED
@@ -7,11 +7,7 @@ title: EntityListing
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **entities** |
|
11
|
-
| **page_size** | **Integer** | | [optional] |
|
12
|
-
| **page_number** | **Integer** | | [optional] |
|
13
|
-
| **total** | **Integer** | | [optional] |
|
14
|
-
| **page_count** | **Integer** | | [optional] |
|
10
|
+
| **entities** | **Array<Object>** | | [optional] |
|
15
11
|
{: class="table table-striped"}
|
16
12
|
|
17
13
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: GoogleDialogflowCustomSettings
|
3
|
+
---
|
4
|
+
## PureCloud::GoogleDialogflowCustomSettings
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **environment** | **String** | If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -10,6 +10,7 @@ Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
11
11
|
[**delete_languageunderstanding_domain**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain) | Delete an NLU Domain.
|
12
12
|
[**delete_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_feedback_feedback_id) | Delete the feedback on the NLU Domain Version.
|
13
|
+
[**delete_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_version) | Delete an NLU Domain Version
|
13
14
|
[**get_languageunderstanding_domain**](LanguageUnderstandingApi.html#get_languageunderstanding_domain) | Find an NLU Domain.
|
14
15
|
[**get_languageunderstanding_domain_feedback**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback) | Get all feedback in the given NLU Domain Version.
|
15
16
|
[**get_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback_feedback_id) | Find a Feedback
|
@@ -22,6 +23,7 @@ Method | Description
|
|
22
23
|
[**post_languageunderstanding_domain_version_detect**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_detect) | Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
|
23
24
|
[**post_languageunderstanding_domain_version_publish**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_publish) | Publish the draft NLU Domain Version.
|
24
25
|
[**post_languageunderstanding_domain_version_train**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_train) | Train the draft NLU Domain Version.
|
26
|
+
[**post_languageunderstanding_domain_versions**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_versions) | Create an NLU Domain Version.
|
25
27
|
[**post_languageunderstanding_domains**](LanguageUnderstandingApi.html#post_languageunderstanding_domains) | Create an NLU Domain.
|
26
28
|
[**put_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#put_languageunderstanding_domain_version) | Update an NLU Domain Version.
|
27
29
|
{: class="table table-striped"}
|
@@ -159,6 +161,74 @@ nil (empty response body)
|
|
159
161
|
|
160
162
|
|
161
163
|
|
164
|
+
<a name="delete_languageunderstanding_domain_version"></a>
|
165
|
+
|
166
|
+
## delete_languageunderstanding_domain_version(domain_id, domain_version_id)
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
Delete an NLU Domain Version
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
Wraps DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
|
175
|
+
|
176
|
+
Requires ANY permissions:
|
177
|
+
|
178
|
+
* languageUnderstanding:nluDomainVersion:delete
|
179
|
+
* dialog:botVersion:delete
|
180
|
+
|
181
|
+
|
182
|
+
### Example
|
183
|
+
```{"language":"ruby"}
|
184
|
+
# load the gem
|
185
|
+
require 'purecloudplatformclientv2'
|
186
|
+
# setup authorization
|
187
|
+
@secret = ENV['PURECLOUD_SECRET']
|
188
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
189
|
+
environment = "mypurecloud.com"
|
190
|
+
|
191
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
192
|
+
|
193
|
+
PureCloud.configure do |config|
|
194
|
+
config.access_token = @authToken
|
195
|
+
end
|
196
|
+
|
197
|
+
api_instance = PureCloud::LanguageUnderstandingApi.new
|
198
|
+
|
199
|
+
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
200
|
+
|
201
|
+
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
202
|
+
|
203
|
+
|
204
|
+
begin
|
205
|
+
#Delete an NLU Domain Version
|
206
|
+
api_instance.delete_languageunderstanding_domain_version(domain_id, domain_version_id)
|
207
|
+
rescue PureCloud::ApiError => e
|
208
|
+
puts "Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_version: #{e}"
|
209
|
+
end
|
210
|
+
```
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
|
214
|
+
Name | Type | Description | Notes
|
215
|
+
------------- | ------------- | ------------- | -------------
|
216
|
+
**domain_id** | **String**| ID of the NLU domain. | |
|
217
|
+
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
218
|
+
{: class="table table-striped"}
|
219
|
+
|
220
|
+
|
221
|
+
### Return type
|
222
|
+
|
223
|
+
nil (empty response body)
|
224
|
+
|
225
|
+
### HTTP request headers
|
226
|
+
|
227
|
+
- **Content-Type**: application/json
|
228
|
+
- **Accept**: application/json
|
229
|
+
|
230
|
+
|
231
|
+
|
162
232
|
<a name="get_languageunderstanding_domain"></a>
|
163
233
|
|
164
234
|
## [**NluDomain**](NluDomain.html) get_languageunderstanding_domain(domain_id)
|
@@ -669,7 +739,7 @@ Name | Type | Description | Notes
|
|
669
739
|
|
670
740
|
<a name="patch_languageunderstanding_domain"></a>
|
671
741
|
|
672
|
-
## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id,
|
742
|
+
## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id, body)
|
673
743
|
|
674
744
|
|
675
745
|
|
@@ -704,13 +774,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
704
774
|
|
705
775
|
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
706
776
|
|
707
|
-
|
708
|
-
|
709
|
-
}
|
777
|
+
body = PureCloud::NluDomain.new # NluDomain | The updated NLU Domain.
|
778
|
+
|
710
779
|
|
711
780
|
begin
|
712
781
|
#Update an NLU Domain.
|
713
|
-
result = api_instance.patch_languageunderstanding_domain(domain_id,
|
782
|
+
result = api_instance.patch_languageunderstanding_domain(domain_id, body)
|
714
783
|
p result
|
715
784
|
rescue PureCloud::ApiError => e
|
716
785
|
puts "Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_domain: #{e}"
|
@@ -722,7 +791,7 @@ end
|
|
722
791
|
Name | Type | Description | Notes
|
723
792
|
------------- | ------------- | ------------- | -------------
|
724
793
|
**domain_id** | **String**| ID of the NLU domain. | |
|
725
|
-
**body** | [**NluDomain**](NluDomain.html)|
|
794
|
+
**body** | [**NluDomain**](NluDomain.html)| The updated NLU Domain. | |
|
726
795
|
{: class="table table-striped"}
|
727
796
|
|
728
797
|
|
@@ -739,7 +808,7 @@ Name | Type | Description | Notes
|
|
739
808
|
|
740
809
|
<a name="post_languageunderstanding_domain_feedback"></a>
|
741
810
|
|
742
|
-
## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id,
|
811
|
+
## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id, body)
|
743
812
|
|
744
813
|
|
745
814
|
|
@@ -774,13 +843,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
774
843
|
|
775
844
|
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
776
845
|
|
777
|
-
|
778
|
-
|
779
|
-
}
|
846
|
+
body = PureCloud::NluFeedbackRequest.new # NluFeedbackRequest | The Feedback to create.
|
847
|
+
|
780
848
|
|
781
849
|
begin
|
782
850
|
#Create feedback for the NLU Domain Version.
|
783
|
-
result = api_instance.post_languageunderstanding_domain_feedback(domain_id,
|
851
|
+
result = api_instance.post_languageunderstanding_domain_feedback(domain_id, body)
|
784
852
|
p result
|
785
853
|
rescue PureCloud::ApiError => e
|
786
854
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_feedback: #{e}"
|
@@ -792,7 +860,7 @@ end
|
|
792
860
|
Name | Type | Description | Notes
|
793
861
|
------------- | ------------- | ------------- | -------------
|
794
862
|
**domain_id** | **String**| ID of the NLU domain. | |
|
795
|
-
**body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)|
|
863
|
+
**body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)| The Feedback to create. | |
|
796
864
|
{: class="table table-striped"}
|
797
865
|
|
798
866
|
|
@@ -809,7 +877,7 @@ Name | Type | Description | Notes
|
|
809
877
|
|
810
878
|
<a name="post_languageunderstanding_domain_version_detect"></a>
|
811
879
|
|
812
|
-
## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id,
|
880
|
+
## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
|
813
881
|
|
814
882
|
|
815
883
|
|
@@ -846,13 +914,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
846
914
|
|
847
915
|
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
848
916
|
|
849
|
-
|
850
|
-
|
851
|
-
}
|
917
|
+
body = PureCloud::NluDetectionRequest.new # NluDetectionRequest | The input data to perform detection on.
|
918
|
+
|
852
919
|
|
853
920
|
begin
|
854
921
|
#Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
|
855
|
-
result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id,
|
922
|
+
result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
|
856
923
|
p result
|
857
924
|
rescue PureCloud::ApiError => e
|
858
925
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_detect: #{e}"
|
@@ -865,7 +932,7 @@ Name | Type | Description | Notes
|
|
865
932
|
------------- | ------------- | ------------- | -------------
|
866
933
|
**domain_id** | **String**| ID of the NLU domain. | |
|
867
934
|
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
868
|
-
**body** | [**NluDetectionRequest**](NluDetectionRequest.html)|
|
935
|
+
**body** | [**NluDetectionRequest**](NluDetectionRequest.html)| The input data to perform detection on. | |
|
869
936
|
{: class="table table-striped"}
|
870
937
|
|
871
938
|
|
@@ -1018,9 +1085,78 @@ Name | Type | Description | Notes
|
|
1018
1085
|
|
1019
1086
|
|
1020
1087
|
|
1088
|
+
<a name="post_languageunderstanding_domain_versions"></a>
|
1089
|
+
|
1090
|
+
## [**NluDomainVersion**](NluDomainVersion.html) post_languageunderstanding_domain_versions(domain_id, body)
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
Create an NLU Domain Version.
|
1095
|
+
|
1096
|
+
|
1097
|
+
|
1098
|
+
Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions
|
1099
|
+
|
1100
|
+
Requires ANY permissions:
|
1101
|
+
|
1102
|
+
* languageUnderstanding:nluDomainVersion:add
|
1103
|
+
* dialog:botVersion:add
|
1104
|
+
|
1105
|
+
|
1106
|
+
### Example
|
1107
|
+
```{"language":"ruby"}
|
1108
|
+
# load the gem
|
1109
|
+
require 'purecloudplatformclientv2'
|
1110
|
+
# setup authorization
|
1111
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1112
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1113
|
+
environment = "mypurecloud.com"
|
1114
|
+
|
1115
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1116
|
+
|
1117
|
+
PureCloud.configure do |config|
|
1118
|
+
config.access_token = @authToken
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
api_instance = PureCloud::LanguageUnderstandingApi.new
|
1122
|
+
|
1123
|
+
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
1124
|
+
|
1125
|
+
body = PureCloud::NluDomainVersion.new # NluDomainVersion | The NLU Domain Version to create.
|
1126
|
+
|
1127
|
+
|
1128
|
+
begin
|
1129
|
+
#Create an NLU Domain Version.
|
1130
|
+
result = api_instance.post_languageunderstanding_domain_versions(domain_id, body)
|
1131
|
+
p result
|
1132
|
+
rescue PureCloud::ApiError => e
|
1133
|
+
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_versions: #{e}"
|
1134
|
+
end
|
1135
|
+
```
|
1136
|
+
|
1137
|
+
### Parameters
|
1138
|
+
|
1139
|
+
Name | Type | Description | Notes
|
1140
|
+
------------- | ------------- | ------------- | -------------
|
1141
|
+
**domain_id** | **String**| ID of the NLU domain. | |
|
1142
|
+
**body** | [**NluDomainVersion**](NluDomainVersion.html)| The NLU Domain Version to create. | |
|
1143
|
+
{: class="table table-striped"}
|
1144
|
+
|
1145
|
+
|
1146
|
+
### Return type
|
1147
|
+
|
1148
|
+
[**NluDomainVersion**](NluDomainVersion.html)
|
1149
|
+
|
1150
|
+
### HTTP request headers
|
1151
|
+
|
1152
|
+
- **Content-Type**: application/json
|
1153
|
+
- **Accept**: application/json
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1021
1157
|
<a name="post_languageunderstanding_domains"></a>
|
1022
1158
|
|
1023
|
-
## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(
|
1159
|
+
## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(body)
|
1024
1160
|
|
1025
1161
|
|
1026
1162
|
|
@@ -1053,13 +1189,12 @@ end
|
|
1053
1189
|
|
1054
1190
|
api_instance = PureCloud::LanguageUnderstandingApi.new
|
1055
1191
|
|
1056
|
-
|
1057
|
-
|
1058
|
-
}
|
1192
|
+
body = PureCloud::NluDomain.new # NluDomain | The NLU Domain to create.
|
1193
|
+
|
1059
1194
|
|
1060
1195
|
begin
|
1061
1196
|
#Create an NLU Domain.
|
1062
|
-
result = api_instance.post_languageunderstanding_domains(
|
1197
|
+
result = api_instance.post_languageunderstanding_domains(body)
|
1063
1198
|
p result
|
1064
1199
|
rescue PureCloud::ApiError => e
|
1065
1200
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domains: #{e}"
|
@@ -1070,7 +1205,7 @@ end
|
|
1070
1205
|
|
1071
1206
|
Name | Type | Description | Notes
|
1072
1207
|
------------- | ------------- | ------------- | -------------
|
1073
|
-
**body** | [**NluDomain**](NluDomain.html)|
|
1208
|
+
**body** | [**NluDomain**](NluDomain.html)| The NLU Domain to create. | |
|
1074
1209
|
{: class="table table-striped"}
|
1075
1210
|
|
1076
1211
|
|
@@ -1087,7 +1222,7 @@ Name | Type | Description | Notes
|
|
1087
1222
|
|
1088
1223
|
<a name="put_languageunderstanding_domain_version"></a>
|
1089
1224
|
|
1090
|
-
## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id,
|
1225
|
+
## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
|
1091
1226
|
|
1092
1227
|
|
1093
1228
|
|
@@ -1124,13 +1259,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
1124
1259
|
|
1125
1260
|
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
1126
1261
|
|
1127
|
-
|
1128
|
-
|
1129
|
-
}
|
1262
|
+
body = PureCloud::NluDomainVersion.new # NluDomainVersion | The updated NLU Domain Version.
|
1263
|
+
|
1130
1264
|
|
1131
1265
|
begin
|
1132
1266
|
#Update an NLU Domain Version.
|
1133
|
-
result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id,
|
1267
|
+
result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
|
1134
1268
|
p result
|
1135
1269
|
rescue PureCloud::ApiError => e
|
1136
1270
|
puts "Exception when calling LanguageUnderstandingApi->put_languageunderstanding_domain_version: #{e}"
|
@@ -1143,7 +1277,7 @@ Name | Type | Description | Notes
|
|
1143
1277
|
------------- | ------------- | ------------- | -------------
|
1144
1278
|
**domain_id** | **String**| ID of the NLU domain. | |
|
1145
1279
|
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
1146
|
-
**body** | [**NluDomainVersion**](NluDomainVersion.html)|
|
1280
|
+
**body** | [**NluDomainVersion**](NluDomainVersion.html)| The updated NLU Domain Version. | |
|
1147
1281
|
{: class="table table-striped"}
|
1148
1282
|
|
1149
1283
|
|