purecloudplatformclientv2 91.0.0 → 92.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AmazonLexRequest.md +14 -0
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/AuditApi.md +70 -0
  6. data/docs/AuditRealtimeQueryRequest.md +18 -0
  7. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  8. data/docs/ButtonComponent.md +16 -0
  9. data/docs/ContentActions.md +17 -0
  10. data/docs/ContentAttachment.md +19 -0
  11. data/docs/ContentGeneric.md +19 -0
  12. data/docs/ContentList.md +19 -0
  13. data/docs/ContentLocation.md +17 -0
  14. data/docs/ContentNotificationTemplate.md +17 -0
  15. data/docs/ContentQuickReply.md +16 -0
  16. data/docs/EdgeGroup.md +1 -0
  17. data/docs/EntityListing.md +1 -5
  18. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  19. data/docs/LanguageUnderstandingApi.md +164 -30
  20. data/docs/ListItemComponent.md +19 -0
  21. data/docs/MessageContent.md +19 -0
  22. data/docs/NluDomainVersion.md +2 -1
  23. data/docs/NotificationTemplateBody.md +14 -0
  24. data/docs/NotificationTemplateFooter.md +13 -0
  25. data/docs/NotificationTemplateHeader.md +16 -0
  26. data/docs/NotificationTemplateParameter.md +14 -0
  27. data/docs/PostTextMessage.md +15 -0
  28. data/docs/PostTextRequest.md +23 -0
  29. data/docs/PostTextResponse.md +20 -0
  30. data/docs/SurveyForm.md +0 -2
  31. data/docs/TextbotsApi.md +78 -0
  32. data/lib/purecloudplatformclientv2.rb +22 -0
  33. data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
  34. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
  35. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  36. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  37. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  38. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  39. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  40. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  41. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  42. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  43. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  44. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  45. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  46. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  47. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  48. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  49. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  50. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  51. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  52. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  53. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  54. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
  55. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  56. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  57. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  58. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  59. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  60. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  61. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  62. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  63. data/lib/purecloudplatformclientv2/version.rb +1 -1
  64. metadata +46 -2
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: ListItemComponent
3
+ ---
4
+ ## PureCloud::ListItemComponent
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | An ID assigned to this component | [optional] |
11
+ | **rmid** | **String** | An ID of the rich message instance | [optional] |
12
+ | **type** | **String** | The type of component to render | [optional] |
13
+ | **image** | **String** | Path or URI to an image file | [optional] |
14
+ | **title** | **String** | The main headline of the list item | [optional] |
15
+ | **description** | **String** | Text to show in the description row | [optional] |
16
+ | **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: MessageContent
3
+ ---
4
+ ## PureCloud::MessageContent
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **content_type** | **String** | Type of this content element. If contentType = \"Attachment\" only one item is allowed. | |
11
+ | **location** | [**ContentLocation**](ContentLocation.html) | Location object | [optional] |
12
+ | **attachment** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
13
+ | **quick_reply** | [**ContentQuickReply**](ContentQuickReply.html) | Quick reply object | [optional] |
14
+ | **generic** | [**ContentGeneric**](ContentGeneric.html) | Generic content object | [optional] |
15
+ | **list** | [**ContentList**](ContentList.html) | List content object | [optional] |
16
+ | **template** | [**ContentNotificationTemplate**](ContentNotificationTemplate.html) | Template notification object | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -10,7 +10,8 @@ title: NluDomainVersion
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **domain** | [**NluDomain**](NluDomain.html) | The NLU domain of the version. | [optional] |
12
12
  | **description** | **String** | The description of the NLU domain version. | [optional] |
13
- | **language** | **String** | The language that the NLU domain version supports. | [optional] |
13
+ | **language** | **String** | The language that the NLU domain version supports. | |
14
+ | **published** | **BOOLEAN** | Whether this NLU domain version has been published. | [optional] |
14
15
  | **date_created** | **DateTime** | The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
16
  | **date_modified** | **DateTime** | The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
17
  | **date_trained** | **DateTime** | The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: NotificationTemplateBody
3
+ ---
4
+ ## PureCloud::NotificationTemplateBody
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **text** | **String** | Body text. For WhatsApp, ignored | [optional] |
11
+ | **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: NotificationTemplateFooter
3
+ ---
4
+ ## PureCloud::NotificationTemplateFooter
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **text** | **String** | Footer text. For WhatsApp, ignored | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: NotificationTemplateHeader
3
+ ---
4
+ ## PureCloud::NotificationTemplateHeader
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **type** | **String** | Template header type | |
11
+ | **text** | **String** | Header text. For WhatsApp, ignored | [optional] |
12
+ | **media** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
13
+ | **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: NotificationTemplateParameter
3
+ ---
4
+ ## PureCloud::NotificationTemplateParameter
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | Parameter name | [optional] |
11
+ | **text** | **String** | Parameter text value | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: PostTextMessage
3
+ ---
4
+ ## PureCloud::PostTextMessage
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **type** | **String** | Message type | |
11
+ | **text** | **String** | Message text. If type is structured, used as fallback for clients that do not support particular structured content | [optional] |
12
+ | **content** | [**Array<MessageContent>**](MessageContent.html) | A list of content elements in message | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: PostTextRequest
3
+ ---
4
+ ## PureCloud::PostTextRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **bot_id** | **String** | ID of the bot to send the text to. | |
11
+ | **bot_alias** | **String** | Alias/Version of the bot | [optional] |
12
+ | **integration_id** | **String** | the integration service id for the bot's credentials | |
13
+ | **bot_session_id** | **String** | GUID for this bot's session | |
14
+ | **post_text_message** | [**PostTextMessage**](PostTextMessage.html) | Message to send to the bot | |
15
+ | **language_code** | **String** | The launguage code the bot will run under | [optional] |
16
+ | **bot_session_timeout_minutes** | **Integer** | Override timeout for the bot session. This should be greater than 10 minutes. | [optional] |
17
+ | **bot_channels** | **Array<String>** | The channels this bot is utilizing | [optional] |
18
+ | **bot_correlation_id** | **String** | Id for tracking the activity - this will be returned in the response | [optional] |
19
+ | **amazon_lex_request** | [**AmazonLexRequest**](AmazonLexRequest.html) | | [optional] |
20
+ | **google_dialogflow** | [**GoogleDialogflowCustomSettings**](GoogleDialogflowCustomSettings.html) | | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: PostTextResponse
3
+ ---
4
+ ## PureCloud::PostTextResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **bot_state** | **String** | The state of the bot after completion of the request | |
11
+ | **reply_messages** | [**Array<PostTextMessage>**](PostTextMessage.html) | The list of messages to respond with, if any | [optional] |
12
+ | **intent_name** | **String** | The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected. | [optional] |
13
+ | **slots** | **Hash<String, String>** | Data parameters detected and filled by the bot. | [optional] |
14
+ | **bot_correlation_id** | **String** | The optional ID specified in the request | [optional] |
15
+ | **amazon_lex** | **Hash<String, Object>** | Raw data response from AWS (if called) | [optional] |
16
+ | **google_dialog_flow** | **Hash<String, Object>** | Raw data response from Google Dialogflow (if called) | [optional] |
17
+ | **genesys_dialog_engine** | **Hash<String, Object>** | Raw data response from Genesys' Dialogengine (if called) | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -14,8 +14,6 @@ title: SurveyForm
14
14
  | **disabled** | **BOOLEAN** | Is this form disabled | [optional] |
15
15
  | **context_id** | **String** | Unique Id for all versions of this form | |
16
16
  | **language** | **String** | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW | |
17
- | **header_image_id** | **String** | Id of the header image appearing at the top of the form. | [optional] |
18
- | **header_image_url** | **String** | Temporary URL for accessing header image | [optional] |
19
17
  | **header** | **String** | Markdown text for the top of the form. | [optional] |
20
18
  | **footer** | **String** | Markdown text for the bottom of the form. | [optional] |
21
19
  | **question_groups** | [**Array<SurveyQuestionGroup>**](SurveyQuestionGroup.html) | A list of question groups | |
@@ -0,0 +1,78 @@
1
+ ---
2
+ title: TextbotsApi
3
+ ---
4
+
5
+ ## PureCloud::TextbotsApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**post_textbots_bots_execute**](TextbotsApi.html#post_textbots_bots_execute) | Send an intent to a bot to start a dialog/interact with it via text
12
+ {: class="table table-striped"}
13
+
14
+ <a name="post_textbots_bots_execute"></a>
15
+
16
+ ## [**PostTextResponse**](PostTextResponse.html) post_textbots_bots_execute(post_text_request)
17
+
18
+
19
+
20
+ Send an intent to a bot to start a dialog/interact with it via text
21
+
22
+ This will either start a bot with the given id or relay a communication to an existing bot session.
23
+
24
+ Wraps POST /api/v2/textbots/bots/execute
25
+
26
+ Requires ANY permissions:
27
+
28
+ * textbots:session:execute
29
+
30
+
31
+ ### Example
32
+ ```{"language":"ruby"}
33
+ # load the gem
34
+ require 'purecloudplatformclientv2'
35
+ # setup authorization
36
+ @secret = ENV['PURECLOUD_SECRET']
37
+ @id = ENV['PURECLOUD_CLIENT_ID']
38
+ environment = "mypurecloud.com"
39
+
40
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
41
+
42
+ PureCloud.configure do |config|
43
+ config.access_token = @authToken
44
+ end
45
+
46
+ api_instance = PureCloud::TextbotsApi.new
47
+
48
+ post_text_request = PureCloud::PostTextRequest.new # PostTextRequest |
49
+
50
+
51
+ begin
52
+ #Send an intent to a bot to start a dialog/interact with it via text
53
+ result = api_instance.post_textbots_bots_execute(post_text_request)
54
+ p result
55
+ rescue PureCloud::ApiError => e
56
+ puts "Exception when calling TextbotsApi->post_textbots_bots_execute: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ Name | Type | Description | Notes
63
+ ------------- | ------------- | ------------- | -------------
64
+ **post_text_request** | [**PostTextRequest**](PostTextRequest.html)| | |
65
+ {: class="table table-striped"}
66
+
67
+
68
+ ### Return type
69
+
70
+ [**PostTextResponse**](PostTextResponse.html)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
78
+
@@ -62,6 +62,7 @@ require 'purecloudplatformclientv2/models/aggregate_view_data'
62
62
  require 'purecloudplatformclientv2/models/aggregation_range'
63
63
  require 'purecloudplatformclientv2/models/aggregation_result'
64
64
  require 'purecloudplatformclientv2/models/aggregation_result_entry'
65
+ require 'purecloudplatformclientv2/models/amazon_lex_request'
65
66
  require 'purecloudplatformclientv2/models/analytics_conversation'
66
67
  require 'purecloudplatformclientv2/models/analytics_conversation_async_query_response'
67
68
  require 'purecloudplatformclientv2/models/analytics_conversation_query_response'
@@ -150,6 +151,8 @@ require 'purecloudplatformclientv2/models/audit_query_response'
150
151
  require 'purecloudplatformclientv2/models/audit_query_service'
151
152
  require 'purecloudplatformclientv2/models/audit_query_service_mapping'
152
153
  require 'purecloudplatformclientv2/models/audit_query_sort'
154
+ require 'purecloudplatformclientv2/models/audit_realtime_query_request'
155
+ require 'purecloudplatformclientv2/models/audit_realtime_query_results_response'
153
156
  require 'purecloudplatformclientv2/models/audit_search_result'
154
157
  require 'purecloudplatformclientv2/models/audit_user'
155
158
  require 'purecloudplatformclientv2/models/authz_division'
@@ -238,6 +241,7 @@ require 'purecloudplatformclientv2/models/business_unit_list_item'
238
241
  require 'purecloudplatformclientv2/models/business_unit_listing'
239
242
  require 'purecloudplatformclientv2/models/business_unit_reference'
240
243
  require 'purecloudplatformclientv2/models/business_unit_settings'
244
+ require 'purecloudplatformclientv2/models/button_component'
241
245
  require 'purecloudplatformclientv2/models/calibration'
242
246
  require 'purecloudplatformclientv2/models/calibration_assignment'
243
247
  require 'purecloudplatformclientv2/models/calibration_create'
@@ -361,9 +365,14 @@ require 'purecloudplatformclientv2/models/contact_phone_number_column'
361
365
  require 'purecloudplatformclientv2/models/contact_sort'
362
366
  require 'purecloudplatformclientv2/models/contactlist_download_ready_export_uri'
363
367
  require 'purecloudplatformclientv2/models/contactlist_import_status_import_status'
368
+ require 'purecloudplatformclientv2/models/content_actions'
369
+ require 'purecloudplatformclientv2/models/content_attachment'
364
370
  require 'purecloudplatformclientv2/models/content_attribute_filter_item'
365
371
  require 'purecloudplatformclientv2/models/content_facet_filter_item'
366
372
  require 'purecloudplatformclientv2/models/content_filter_item'
373
+ require 'purecloudplatformclientv2/models/content_generic'
374
+ require 'purecloudplatformclientv2/models/content_list'
375
+ require 'purecloudplatformclientv2/models/content_location'
367
376
  require 'purecloudplatformclientv2/models/content_management_single_document_topic_document_data_v2'
368
377
  require 'purecloudplatformclientv2/models/content_management_single_document_topic_lock_data'
369
378
  require 'purecloudplatformclientv2/models/content_management_single_document_topic_user_data'
@@ -372,7 +381,9 @@ require 'purecloudplatformclientv2/models/content_management_workspace_documents
372
381
  require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_lock_data'
373
382
  require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_user_data'
374
383
  require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_workspace_data'
384
+ require 'purecloudplatformclientv2/models/content_notification_template'
375
385
  require 'purecloudplatformclientv2/models/content_query_request'
386
+ require 'purecloudplatformclientv2/models/content_quick_reply'
376
387
  require 'purecloudplatformclientv2/models/content_sort_item'
377
388
  require 'purecloudplatformclientv2/models/context_entity'
378
389
  require 'purecloudplatformclientv2/models/context_intent'
@@ -927,6 +938,7 @@ require 'purecloudplatformclientv2/models/generic_saml'
927
938
  require 'purecloudplatformclientv2/models/geolocation'
928
939
  require 'purecloudplatformclientv2/models/geolocation_event_geolocation'
929
940
  require 'purecloudplatformclientv2/models/geolocation_settings'
941
+ require 'purecloudplatformclientv2/models/google_dialogflow_custom_settings'
930
942
  require 'purecloudplatformclientv2/models/greeting'
931
943
  require 'purecloudplatformclientv2/models/greeting_audio_file'
932
944
  require 'purecloudplatformclientv2/models/greeting_listing'
@@ -1049,6 +1061,7 @@ require 'purecloudplatformclientv2/models/line_integration_entity_listing'
1049
1061
  require 'purecloudplatformclientv2/models/line_integration_request'
1050
1062
  require 'purecloudplatformclientv2/models/line_status'
1051
1063
  require 'purecloudplatformclientv2/models/line_user_id'
1064
+ require 'purecloudplatformclientv2/models/list_item_component'
1052
1065
  require 'purecloudplatformclientv2/models/list_wrapper_interval'
1053
1066
  require 'purecloudplatformclientv2/models/list_wrapper_shift_start_variance'
1054
1067
  require 'purecloudplatformclientv2/models/local_encryption_configuration'
@@ -1092,6 +1105,7 @@ require 'purecloudplatformclientv2/models/media_transcription'
1092
1105
  require 'purecloudplatformclientv2/models/media_utilization'
1093
1106
  require 'purecloudplatformclientv2/models/member_entity'
1094
1107
  require 'purecloudplatformclientv2/models/message'
1108
+ require 'purecloudplatformclientv2/models/message_content'
1095
1109
  require 'purecloudplatformclientv2/models/message_conversation'
1096
1110
  require 'purecloudplatformclientv2/models/message_conversation_entity_listing'
1097
1111
  require 'purecloudplatformclientv2/models/message_data'
@@ -1151,6 +1165,10 @@ require 'purecloudplatformclientv2/models/nlu_utterance'
1151
1165
  require 'purecloudplatformclientv2/models/nlu_utterance_segment'
1152
1166
  require 'purecloudplatformclientv2/models/note'
1153
1167
  require 'purecloudplatformclientv2/models/note_listing'
1168
+ require 'purecloudplatformclientv2/models/notification_template_body'
1169
+ require 'purecloudplatformclientv2/models/notification_template_footer'
1170
+ require 'purecloudplatformclientv2/models/notification_template_header'
1171
+ require 'purecloudplatformclientv2/models/notification_template_parameter'
1154
1172
  require 'purecloudplatformclientv2/models/notifications_response'
1155
1173
  require 'purecloudplatformclientv2/models/number'
1156
1174
  require 'purecloudplatformclientv2/models/number_plan'
@@ -1236,6 +1254,9 @@ require 'purecloudplatformclientv2/models/policy_errors'
1236
1254
  require 'purecloudplatformclientv2/models/post_action_input'
1237
1255
  require 'purecloudplatformclientv2/models/post_input_contract'
1238
1256
  require 'purecloudplatformclientv2/models/post_output_contract'
1257
+ require 'purecloudplatformclientv2/models/post_text_message'
1258
+ require 'purecloudplatformclientv2/models/post_text_request'
1259
+ require 'purecloudplatformclientv2/models/post_text_response'
1239
1260
  require 'purecloudplatformclientv2/models/prediction_results'
1240
1261
  require 'purecloudplatformclientv2/models/presence_definition'
1241
1262
  require 'purecloudplatformclientv2/models/presence_detail_query_clause'
@@ -2105,6 +2126,7 @@ require 'purecloudplatformclientv2/api/stations_api'
2105
2126
  require 'purecloudplatformclientv2/api/suggest_api'
2106
2127
  require 'purecloudplatformclientv2/api/telephony_api'
2107
2128
  require 'purecloudplatformclientv2/api/telephony_providers_edge_api'
2129
+ require 'purecloudplatformclientv2/api/textbots_api'
2108
2130
  require 'purecloudplatformclientv2/api/tokens_api'
2109
2131
  require 'purecloudplatformclientv2/api/uploads_api'
2110
2132
  require 'purecloudplatformclientv2/api/usage_api'
@@ -300,5 +300,79 @@ module PureCloud
300
300
  end
301
301
  return data, status_code, headers
302
302
  end
303
+
304
+ # This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
305
+ #
306
+ # @param body query
307
+ # @param [Hash] opts the optional parameters
308
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
309
+ # @return [AuditRealtimeQueryResultsResponse]
310
+ def post_audits_query_realtime(body, opts = {})
311
+ data, _status_code, _headers = post_audits_query_realtime_with_http_info(body, opts)
312
+ return data
313
+ end
314
+
315
+ # This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
316
+ #
317
+ # @param body query
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
320
+ # @return [Array<(AuditRealtimeQueryResultsResponse, Fixnum, Hash)>] AuditRealtimeQueryResultsResponse data, response status code and response headers
321
+ def post_audits_query_realtime_with_http_info(body, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "Calling API: AuditApi.post_audits_query_realtime ..."
324
+ end
325
+
326
+
327
+ # verify the required parameter 'body' is set
328
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuditApi.post_audits_query_realtime" if body.nil?
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ # resource path
341
+ local_var_path = "/api/v2/audits/query/realtime".sub('{format}','json')
342
+
343
+ # query parameters
344
+ query_params = {}
345
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
346
+
347
+ # header parameters
348
+ header_params = {}
349
+
350
+ # HTTP header 'Accept' (if needed)
351
+ local_header_accept = ['application/json']
352
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
353
+
354
+ # HTTP header 'Content-Type'
355
+ local_header_content_type = ['application/json']
356
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
357
+
358
+ # form parameters
359
+ form_params = {}
360
+
361
+ # http body (model)
362
+ post_body = @api_client.object_to_http_body(body)
363
+
364
+ auth_names = ['PureCloud OAuth']
365
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
366
+ :header_params => header_params,
367
+ :query_params => query_params,
368
+ :form_params => form_params,
369
+ :body => post_body,
370
+ :auth_names => auth_names,
371
+ :return_type => 'AuditRealtimeQueryResultsResponse')
372
+ if @api_client.config.debugging
373
+ @api_client.config.logger.debug "API called: AuditApi#post_audits_query_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
374
+ end
375
+ return data, status_code, headers
376
+ end
303
377
  end
304
378
  end
@@ -162,6 +162,80 @@ module PureCloud
162
162
  return data, status_code, headers
163
163
  end
164
164
 
165
+ # Delete an NLU Domain Version
166
+ #
167
+ # @param domain_id ID of the NLU domain.
168
+ # @param domain_version_id ID of the NLU domain version.
169
+ # @param [Hash] opts the optional parameters
170
+ # @return [nil]
171
+ def delete_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {})
172
+ delete_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts)
173
+ return nil
174
+ end
175
+
176
+ # Delete an NLU Domain Version
177
+ #
178
+ # @param domain_id ID of the NLU domain.
179
+ # @param domain_version_id ID of the NLU domain version.
180
+ # @param [Hash] opts the optional parameters
181
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
182
+ def delete_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {})
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.delete_languageunderstanding_domain_version ..."
185
+ end
186
+
187
+
188
+ # verify the required parameter 'domain_id' is set
189
+ fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_version" if domain_id.nil?
190
+
191
+
192
+
193
+
194
+
195
+
196
+ # verify the required parameter 'domain_version_id' is set
197
+ fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_version" if domain_version_id.nil?
198
+
199
+
200
+
201
+
202
+
203
+ # resource path
204
+ local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)
205
+
206
+ # query parameters
207
+ query_params = {}
208
+
209
+ # header parameters
210
+ header_params = {}
211
+
212
+ # HTTP header 'Accept' (if needed)
213
+ local_header_accept = ['application/json']
214
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
215
+
216
+ # HTTP header 'Content-Type'
217
+ local_header_content_type = ['application/json']
218
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
219
+
220
+ # form parameters
221
+ form_params = {}
222
+
223
+ # http body (model)
224
+ post_body = nil
225
+
226
+ auth_names = ['PureCloud OAuth']
227
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
228
+ :header_params => header_params,
229
+ :query_params => query_params,
230
+ :form_params => form_params,
231
+ :body => post_body,
232
+ :auth_names => auth_names)
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug "API called: LanguageUnderstandingApi#delete_languageunderstanding_domain_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ end
236
+ return data, status_code, headers
237
+ end
238
+
165
239
  # Find an NLU Domain.
166
240
  #
167
241
  # @param domain_id ID of the NLU domain.
@@ -779,21 +853,21 @@ module PureCloud
779
853
  # Update an NLU Domain.
780
854
  #
781
855
  # @param domain_id ID of the NLU domain.
856
+ # @param body The updated NLU Domain.
782
857
  # @param [Hash] opts the optional parameters
783
- # @option opts [NluDomain] :body
784
858
  # @return [NluDomain]
785
- def patch_languageunderstanding_domain(domain_id, opts = {})
786
- data, _status_code, _headers = patch_languageunderstanding_domain_with_http_info(domain_id, opts)
859
+ def patch_languageunderstanding_domain(domain_id, body, opts = {})
860
+ data, _status_code, _headers = patch_languageunderstanding_domain_with_http_info(domain_id, body, opts)
787
861
  return data
788
862
  end
789
863
 
790
864
  # Update an NLU Domain.
791
865
  #
792
866
  # @param domain_id ID of the NLU domain.
867
+ # @param body The updated NLU Domain.
793
868
  # @param [Hash] opts the optional parameters
794
- # @option opts [NluDomain] :body
795
869
  # @return [Array<(NluDomain, Fixnum, Hash)>] NluDomain data, response status code and response headers
796
- def patch_languageunderstanding_domain_with_http_info(domain_id, opts = {})
870
+ def patch_languageunderstanding_domain_with_http_info(domain_id, body, opts = {})
797
871
  if @api_client.config.debugging
798
872
  @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.patch_languageunderstanding_domain ..."
799
873
  end
@@ -807,6 +881,8 @@ module PureCloud
807
881
 
808
882
 
809
883
 
884
+ # verify the required parameter 'body' is set
885
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.patch_languageunderstanding_domain" if body.nil?
810
886
 
811
887
 
812
888
 
@@ -833,7 +909,7 @@ module PureCloud
833
909
  form_params = {}
834
910
 
835
911
  # http body (model)
836
- post_body = @api_client.object_to_http_body(opts[:'body'])
912
+ post_body = @api_client.object_to_http_body(body)
837
913
 
838
914
  auth_names = ['PureCloud OAuth']
839
915
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
@@ -852,21 +928,21 @@ module PureCloud
852
928
  # Create feedback for the NLU Domain Version.
853
929
  #
854
930
  # @param domain_id ID of the NLU domain.
931
+ # @param body The Feedback to create.
855
932
  # @param [Hash] opts the optional parameters
856
- # @option opts [NluFeedbackRequest] :body
857
933
  # @return [NluFeedbackResponse]
858
- def post_languageunderstanding_domain_feedback(domain_id, opts = {})
859
- data, _status_code, _headers = post_languageunderstanding_domain_feedback_with_http_info(domain_id, opts)
934
+ def post_languageunderstanding_domain_feedback(domain_id, body, opts = {})
935
+ data, _status_code, _headers = post_languageunderstanding_domain_feedback_with_http_info(domain_id, body, opts)
860
936
  return data
861
937
  end
862
938
 
863
939
  # Create feedback for the NLU Domain Version.
864
940
  #
865
941
  # @param domain_id ID of the NLU domain.
942
+ # @param body The Feedback to create.
866
943
  # @param [Hash] opts the optional parameters
867
- # @option opts [NluFeedbackRequest] :body
868
944
  # @return [Array<(NluFeedbackResponse, Fixnum, Hash)>] NluFeedbackResponse data, response status code and response headers
869
- def post_languageunderstanding_domain_feedback_with_http_info(domain_id, opts = {})
945
+ def post_languageunderstanding_domain_feedback_with_http_info(domain_id, body, opts = {})
870
946
  if @api_client.config.debugging
871
947
  @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_feedback ..."
872
948
  end
@@ -880,6 +956,8 @@ module PureCloud
880
956
 
881
957
 
882
958
 
959
+ # verify the required parameter 'body' is set
960
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_feedback" if body.nil?
883
961
 
884
962
 
885
963
 
@@ -906,7 +984,7 @@ module PureCloud
906
984
  form_params = {}
907
985
 
908
986
  # http body (model)
909
- post_body = @api_client.object_to_http_body(opts[:'body'])
987
+ post_body = @api_client.object_to_http_body(body)
910
988
 
911
989
  auth_names = ['PureCloud OAuth']
912
990
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
@@ -926,11 +1004,11 @@ module PureCloud
926
1004
  #
927
1005
  # @param domain_id ID of the NLU domain.
928
1006
  # @param domain_version_id ID of the NLU domain version.
1007
+ # @param body The input data to perform detection on.
929
1008
  # @param [Hash] opts the optional parameters
930
- # @option opts [NluDetectionRequest] :body
931
1009
  # @return [NluDetectionResponse]
932
- def post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, opts = {})
933
- data, _status_code, _headers = post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, opts)
1010
+ def post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body, opts = {})
1011
+ data, _status_code, _headers = post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, body, opts)
934
1012
  return data
935
1013
  end
936
1014
 
@@ -938,10 +1016,10 @@ module PureCloud
938
1016
  #
939
1017
  # @param domain_id ID of the NLU domain.
940
1018
  # @param domain_version_id ID of the NLU domain version.
1019
+ # @param body The input data to perform detection on.
941
1020
  # @param [Hash] opts the optional parameters
942
- # @option opts [NluDetectionRequest] :body
943
1021
  # @return [Array<(NluDetectionResponse, Fixnum, Hash)>] NluDetectionResponse data, response status code and response headers
944
- def post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, opts = {})
1022
+ def post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, body, opts = {})
945
1023
  if @api_client.config.debugging
946
1024
  @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect ..."
947
1025
  end
@@ -963,6 +1041,8 @@ module PureCloud
963
1041
 
964
1042
 
965
1043
 
1044
+ # verify the required parameter 'body' is set
1045
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect" if body.nil?
966
1046
 
967
1047
 
968
1048
 
@@ -989,7 +1069,7 @@ module PureCloud
989
1069
  form_params = {}
990
1070
 
991
1071
  # http body (model)
992
- post_body = @api_client.object_to_http_body(opts[:'body'])
1072
+ post_body = @api_client.object_to_http_body(body)
993
1073
 
994
1074
  auth_names = ['PureCloud OAuth']
995
1075
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
@@ -1155,27 +1235,104 @@ module PureCloud
1155
1235
  return data, status_code, headers
1156
1236
  end
1157
1237
 
1238
+ # Create an NLU Domain Version.
1239
+ #
1240
+ # @param domain_id ID of the NLU domain.
1241
+ # @param body The NLU Domain Version to create.
1242
+ # @param [Hash] opts the optional parameters
1243
+ # @return [NluDomainVersion]
1244
+ def post_languageunderstanding_domain_versions(domain_id, body, opts = {})
1245
+ data, _status_code, _headers = post_languageunderstanding_domain_versions_with_http_info(domain_id, body, opts)
1246
+ return data
1247
+ end
1248
+
1249
+ # Create an NLU Domain Version.
1250
+ #
1251
+ # @param domain_id ID of the NLU domain.
1252
+ # @param body The NLU Domain Version to create.
1253
+ # @param [Hash] opts the optional parameters
1254
+ # @return [Array<(NluDomainVersion, Fixnum, Hash)>] NluDomainVersion data, response status code and response headers
1255
+ def post_languageunderstanding_domain_versions_with_http_info(domain_id, body, opts = {})
1256
+ if @api_client.config.debugging
1257
+ @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_versions ..."
1258
+ end
1259
+
1260
+
1261
+ # verify the required parameter 'domain_id' is set
1262
+ fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_versions" if domain_id.nil?
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+ # verify the required parameter 'body' is set
1270
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_versions" if body.nil?
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+ # resource path
1277
+ local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)
1278
+
1279
+ # query parameters
1280
+ query_params = {}
1281
+
1282
+ # header parameters
1283
+ header_params = {}
1284
+
1285
+ # HTTP header 'Accept' (if needed)
1286
+ local_header_accept = ['application/json']
1287
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1288
+
1289
+ # HTTP header 'Content-Type'
1290
+ local_header_content_type = ['application/json']
1291
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1292
+
1293
+ # form parameters
1294
+ form_params = {}
1295
+
1296
+ # http body (model)
1297
+ post_body = @api_client.object_to_http_body(body)
1298
+
1299
+ auth_names = ['PureCloud OAuth']
1300
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1301
+ :header_params => header_params,
1302
+ :query_params => query_params,
1303
+ :form_params => form_params,
1304
+ :body => post_body,
1305
+ :auth_names => auth_names,
1306
+ :return_type => 'NluDomainVersion')
1307
+ if @api_client.config.debugging
1308
+ @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1309
+ end
1310
+ return data, status_code, headers
1311
+ end
1312
+
1158
1313
  # Create an NLU Domain.
1159
1314
  #
1315
+ # @param body The NLU Domain to create.
1160
1316
  # @param [Hash] opts the optional parameters
1161
- # @option opts [NluDomain] :body
1162
1317
  # @return [NluDomain]
1163
- def post_languageunderstanding_domains(opts = {})
1164
- data, _status_code, _headers = post_languageunderstanding_domains_with_http_info(opts)
1318
+ def post_languageunderstanding_domains(body, opts = {})
1319
+ data, _status_code, _headers = post_languageunderstanding_domains_with_http_info(body, opts)
1165
1320
  return data
1166
1321
  end
1167
1322
 
1168
1323
  # Create an NLU Domain.
1169
1324
  #
1325
+ # @param body The NLU Domain to create.
1170
1326
  # @param [Hash] opts the optional parameters
1171
- # @option opts [NluDomain] :body
1172
1327
  # @return [Array<(NluDomain, Fixnum, Hash)>] NluDomain data, response status code and response headers
1173
- def post_languageunderstanding_domains_with_http_info(opts = {})
1328
+ def post_languageunderstanding_domains_with_http_info(body, opts = {})
1174
1329
  if @api_client.config.debugging
1175
1330
  @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domains ..."
1176
1331
  end
1177
1332
 
1178
1333
 
1334
+ # verify the required parameter 'body' is set
1335
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domains" if body.nil?
1179
1336
 
1180
1337
 
1181
1338
 
@@ -1202,7 +1359,7 @@ module PureCloud
1202
1359
  form_params = {}
1203
1360
 
1204
1361
  # http body (model)
1205
- post_body = @api_client.object_to_http_body(opts[:'body'])
1362
+ post_body = @api_client.object_to_http_body(body)
1206
1363
 
1207
1364
  auth_names = ['PureCloud OAuth']
1208
1365
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
@@ -1222,11 +1379,11 @@ module PureCloud
1222
1379
  #
1223
1380
  # @param domain_id ID of the NLU domain.
1224
1381
  # @param domain_version_id ID of the NLU domain version.
1382
+ # @param body The updated NLU Domain Version.
1225
1383
  # @param [Hash] opts the optional parameters
1226
- # @option opts [NluDomainVersion] :body
1227
1384
  # @return [NluDomainVersion]
1228
- def put_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {})
1229
- data, _status_code, _headers = put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts)
1385
+ def put_languageunderstanding_domain_version(domain_id, domain_version_id, body, opts = {})
1386
+ data, _status_code, _headers = put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, body, opts)
1230
1387
  return data
1231
1388
  end
1232
1389
 
@@ -1234,10 +1391,10 @@ module PureCloud
1234
1391
  #
1235
1392
  # @param domain_id ID of the NLU domain.
1236
1393
  # @param domain_version_id ID of the NLU domain version.
1394
+ # @param body The updated NLU Domain Version.
1237
1395
  # @param [Hash] opts the optional parameters
1238
- # @option opts [NluDomainVersion] :body
1239
1396
  # @return [Array<(NluDomainVersion, Fixnum, Hash)>] NluDomainVersion data, response status code and response headers
1240
- def put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {})
1397
+ def put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, body, opts = {})
1241
1398
  if @api_client.config.debugging
1242
1399
  @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.put_languageunderstanding_domain_version ..."
1243
1400
  end
@@ -1259,6 +1416,8 @@ module PureCloud
1259
1416
 
1260
1417
 
1261
1418
 
1419
+ # verify the required parameter 'body' is set
1420
+ fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.put_languageunderstanding_domain_version" if body.nil?
1262
1421
 
1263
1422
 
1264
1423
 
@@ -1285,7 +1444,7 @@ module PureCloud
1285
1444
  form_params = {}
1286
1445
 
1287
1446
  # http body (model)
1288
- post_body = @api_client.object_to_http_body(opts[:'body'])
1447
+ post_body = @api_client.object_to_http_body(body)
1289
1448
 
1290
1449
  auth_names = ['PureCloud OAuth']
1291
1450
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,