purecloudplatformclientv2 87.0.0 → 92.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AmazonLexRequest.md +14 -0
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/ApiUsageQuery.md +16 -0
  6. data/docs/ApiUsageQueryResult.md +14 -0
  7. data/docs/ApiUsageRow.md +25 -0
  8. data/docs/ArchitectApi.md +132 -0
  9. data/docs/AuditApi.md +130 -0
  10. data/docs/AuditQueryEntity.md +14 -0
  11. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  12. data/docs/AuditQueryRequest.md +1 -0
  13. data/docs/AuditQueryService.md +14 -0
  14. data/docs/AuditQueryServiceMapping.md +13 -0
  15. data/docs/AuditQuerySort.md +14 -0
  16. data/docs/AuditRealtimeQueryRequest.md +18 -0
  17. data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
  18. data/docs/BuAgentScheduleActivity.md +2 -0
  19. data/docs/BuRescheduleRequest.md +2 -2
  20. data/docs/ButtonComponent.md +16 -0
  21. data/docs/CoachingApi.md +1 -1
  22. data/docs/ContentActions.md +17 -0
  23. data/docs/ContentAttachment.md +19 -0
  24. data/docs/ContentGeneric.md +19 -0
  25. data/docs/ContentList.md +19 -0
  26. data/docs/ContentLocation.md +17 -0
  27. data/docs/ContentNotificationTemplate.md +17 -0
  28. data/docs/ContentQuickReply.md +16 -0
  29. data/docs/ConversationAggregationQuery.md +1 -1
  30. data/docs/CreateQueueRequest.md +1 -0
  31. data/docs/EdgeGroup.md +1 -0
  32. data/docs/EntityListing.md +1 -5
  33. data/docs/EvaluationAggregationQuery.md +1 -1
  34. data/docs/ExternalContact.md +2 -0
  35. data/docs/ExternalOrganization.md +2 -0
  36. data/docs/FlowAggregationQuery.md +1 -1
  37. data/docs/FlowExecutionLaunchRequest.md +16 -0
  38. data/docs/FlowExecutionLaunchResponse.md +16 -0
  39. data/docs/FlowRuntimeExecution.md +23 -0
  40. data/docs/GenericSAML.md +22 -0
  41. data/docs/GoogleDialogflowCustomSettings.md +13 -0
  42. data/docs/GroupsApi.md +4 -4
  43. data/docs/IdentityProviderApi.md +187 -0
  44. data/docs/IpAddressAuthentication.md +13 -0
  45. data/docs/KnowledgeSearchResponse.md +1 -1
  46. data/docs/LanguageUnderstandingApi.md +164 -30
  47. data/docs/ListItemComponent.md +19 -0
  48. data/docs/MessageContent.md +19 -0
  49. data/docs/NluDomainVersion.md +3 -1
  50. data/docs/NotificationTemplateBody.md +14 -0
  51. data/docs/NotificationTemplateFooter.md +13 -0
  52. data/docs/NotificationTemplateHeader.md +16 -0
  53. data/docs/NotificationTemplateParameter.md +14 -0
  54. data/docs/OAuthApi.md +208 -0
  55. data/docs/OrganizationApi.md +126 -0
  56. data/docs/PostTextMessage.md +15 -0
  57. data/docs/PostTextRequest.md +23 -0
  58. data/docs/PostTextResponse.md +20 -0
  59. data/docs/Prompt.md +2 -2
  60. data/docs/Queue.md +1 -0
  61. data/docs/QueueRequest.md +1 -0
  62. data/docs/RecordingApi.md +12 -0
  63. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  64. data/docs/ScimEmail.md +1 -1
  65. data/docs/SurveyAggregationQuery.md +1 -1
  66. data/docs/SurveyForm.md +0 -2
  67. data/docs/TextbotsApi.md +78 -0
  68. data/docs/UploadUrlRequest.md +1 -0
  69. data/docs/UsageApi.md +144 -0
  70. data/docs/UsageExecutionResult.md +14 -0
  71. data/docs/UserAggregationQuery.md +1 -1
  72. data/docs/UserQueue.md +1 -0
  73. data/docs/UsersApi.md +5 -5
  74. data/docs/ViewFilter.md +2 -0
  75. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  76. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  77. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  78. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  79. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  80. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  81. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  82. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  83. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  84. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  85. data/docs/WorkforceManagementApi.md +3 -3
  86. data/lib/purecloudplatformclientv2.rb +45 -0
  87. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  88. data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
  89. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  90. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  91. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
  92. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  93. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  94. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  95. data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
  96. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
  101. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  102. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  103. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  104. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  106. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  107. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
  108. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
  109. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  110. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  111. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  112. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
  113. data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
  114. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  115. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  116. data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
  117. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +2 -2
  118. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +2 -2
  119. data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
  120. data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
  121. data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
  122. data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
  123. data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
  124. data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
  125. data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
  126. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  127. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  128. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  129. data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
  130. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  131. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  132. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  133. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  134. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  135. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  136. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  137. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  138. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  139. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  140. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  141. data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
  142. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  143. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  144. data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
  145. data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +72 -1
  147. data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
  148. data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
  149. data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
  150. data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
  151. data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
  152. data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
  153. data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
  154. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  155. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  156. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  157. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  158. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  159. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  160. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  161. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  162. data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
  163. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  164. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  165. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  166. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  167. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  168. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  169. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  170. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  171. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  172. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  173. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  174. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  175. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  176. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  177. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +92 -2
@@ -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
+
@@ -10,8 +10,8 @@ title: Prompt
10
10
  | **id** | **String** | The prompt identifier | [optional] |
11
11
  | **name** | **String** | The prompt name. | |
12
12
  | **description** | **String** | | [optional] |
13
- | **resources** | [**Array<PromptAsset>**](PromptAsset.html) | | [optional] |
14
- | **current_operation** | [**Operation**](Operation.html) | | [optional] |
13
+ | **resources** | [**Array<PromptAsset>**](PromptAsset.html) | List of resources associated with this prompt | [optional] |
14
+ | **current_operation** | [**Operation**](Operation.html) | Current prompt operation status | [optional] |
15
15
  | **self_uri** | **String** | The URI for this object | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
@@ -17,6 +17,7 @@ title: Queue
17
17
  | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
18
18
  | **member_count** | **Integer** | The number of users in the queue. | [optional] |
19
19
  | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
20
+ | **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
20
21
  | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
21
22
  | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
22
23
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
@@ -17,6 +17,7 @@ title: QueueRequest
17
17
  | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
18
18
  | **member_count** | **Integer** | The number of users in the queue. | [optional] |
19
19
  | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
20
+ | **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
20
21
  | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
21
22
  | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
22
23
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
@@ -421,6 +421,9 @@ recording_id = "recording_id_example" # String | Recording ID
421
421
 
422
422
  opts = {
423
423
  format_id: "WEBM", # String | The desired media format.
424
+ email_format_id: "EML", # String | The desired media format when downloading an email recording.
425
+ chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
426
+ message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
424
427
  download: false, # BOOLEAN | requesting a download format of the recording
425
428
  file_name: "file_name_example", # String | the name of the downloaded fileName
426
429
  locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
@@ -442,6 +445,9 @@ Name | Type | Description | Notes
442
445
  **conversation_id** | **String**| Conversation ID | |
443
446
  **recording_id** | **String**| Recording ID | |
444
447
  **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
448
+ **email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
449
+ **chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
450
+ **message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
445
451
  **download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
446
452
  **file_name** | **String**| the name of the downloaded fileName | [optional] |
447
453
  **locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
@@ -904,6 +910,9 @@ orphan_id = "orphan_id_example" # String | Orphan ID
904
910
 
905
911
  opts = {
906
912
  format_id: "WEBM", # String | The desired media format.
913
+ email_format_id: "EML", # String | The desired media format when downloading an email recording.
914
+ chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
915
+ message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
907
916
  download: false, # BOOLEAN | requesting a download format of the recording
908
917
  file_name: "file_name_example", # String | the name of the downloaded fileName
909
918
  locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
@@ -924,6 +933,9 @@ Name | Type | Description | Notes
924
933
  ------------- | ------------- | ------------- | -------------
925
934
  **orphan_id** | **String**| Orphan ID | |
926
935
  **format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
936
+ **email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
937
+ **chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
938
+ **message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
927
939
  **download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
928
940
  **file_name** | **String**| the name of the downloaded fileName | [optional] |
929
941
  **locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
@@ -18,6 +18,7 @@ title: ReportingDataExportTopicDataExportNotification
18
18
  | **created_date_time** | **DateTime** | | [optional] |
19
19
  | **modified_date_time** | **DateTime** | | [optional] |
20
20
  | **percentage_complete** | **Float** | | [optional] |
21
+ | **email_statuses** | **Hash&lt;String, String&gt;** | | [optional] |
21
22
  {: class="table table-striped"}
22
23
 
23
24
 
@@ -7,7 +7,7 @@ title: ScimEmail
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **value** | **String** | The email address. | [optional] |
10
+ | **value** | **String** | The email address. Note value for type &#39;other&#39;is immutable. | [optional] |
11
11
  | **type** | **String** | The type of email address. | [optional] |
12
12
  | **primary** | **BOOLEAN** | Indicates whether the email address is the primary email address. | [optional] |
13
13
  {: class="table table-striped"}
@@ -9,7 +9,7 @@ title: SurveyAggregationQuery
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
11
11
  | **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
12
- | **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
12
+ | **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
13
13
  | **group_by** | **Array&lt;String&gt;** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
14
14
  | **filter** | [**SurveyAggregateQueryFilter**](SurveyAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
15
15
  | **metrics** | **Array&lt;String&gt;** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
@@ -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&lt;SurveyQuestionGroup&gt;**](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
+
@@ -10,6 +10,7 @@ title: UploadUrlRequest
10
10
  | **file_name** | **String** | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\&quot;&gt;[~&lt;#| | [optional] |
11
11
  | **content_md5** | **String** | Content MD-5 of the file to upload | [optional] |
12
12
  | **signed_url_timeout_seconds** | **Integer** | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds | [optional] |
13
+ | **server_side_encryption** | **String** | | [optional] |
13
14
  {: class="table table-striped"}
14
15
 
15
16
 
@@ -0,0 +1,144 @@
1
+ ---
2
+ title: UsageApi
3
+ ---
4
+
5
+ ## PureCloud::UsageApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**get_usage_query_execution_id_results**](UsageApi.html#get_usage_query_execution_id_results) | Get the results of a usage query
12
+ [**post_usage_query**](UsageApi.html#post_usage_query) | Query organization API Usage -
13
+ {: class="table table-striped"}
14
+
15
+ <a name="get_usage_query_execution_id_results"></a>
16
+
17
+ ## [**ApiUsageQueryResult**](ApiUsageQueryResult.html) get_usage_query_execution_id_results(execution_id)
18
+
19
+
20
+
21
+ Get the results of a usage query
22
+
23
+
24
+
25
+ Wraps GET /api/v2/usage/query/{executionId}/results
26
+
27
+ Requires ANY permissions:
28
+
29
+ * oauth:client:view
30
+
31
+
32
+ ### Example
33
+ ```{"language":"ruby"}
34
+ # load the gem
35
+ require 'purecloudplatformclientv2'
36
+ # setup authorization
37
+ @secret = ENV['PURECLOUD_SECRET']
38
+ @id = ENV['PURECLOUD_CLIENT_ID']
39
+ environment = "mypurecloud.com"
40
+
41
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
42
+
43
+ PureCloud.configure do |config|
44
+ config.access_token = @authToken
45
+ end
46
+
47
+ api_instance = PureCloud::UsageApi.new
48
+
49
+ execution_id = "execution_id_example" # String | ID of the query execution
50
+
51
+
52
+ begin
53
+ #Get the results of a usage query
54
+ result = api_instance.get_usage_query_execution_id_results(execution_id)
55
+ p result
56
+ rescue PureCloud::ApiError => e
57
+ puts "Exception when calling UsageApi->get_usage_query_execution_id_results: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **execution_id** | **String**| ID of the query execution | |
66
+ {: class="table table-striped"}
67
+
68
+
69
+ ### Return type
70
+
71
+ [**ApiUsageQueryResult**](ApiUsageQueryResult.html)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/json
76
+ - **Accept**: application/json
77
+
78
+
79
+
80
+ <a name="post_usage_query"></a>
81
+
82
+ ## [**UsageExecutionResult**](UsageExecutionResult.html) post_usage_query(body)
83
+
84
+
85
+
86
+ Query organization API Usage -
87
+
88
+ After calling this method, you will then need to poll for the query results based on the returned execution Id
89
+
90
+ Wraps POST /api/v2/usage/query
91
+
92
+ Requires ANY permissions:
93
+
94
+ * oauth:client:view
95
+
96
+
97
+ ### Example
98
+ ```{"language":"ruby"}
99
+ # load the gem
100
+ require 'purecloudplatformclientv2'
101
+ # setup authorization
102
+ @secret = ENV['PURECLOUD_SECRET']
103
+ @id = ENV['PURECLOUD_CLIENT_ID']
104
+ environment = "mypurecloud.com"
105
+
106
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
107
+
108
+ PureCloud.configure do |config|
109
+ config.access_token = @authToken
110
+ end
111
+
112
+ api_instance = PureCloud::UsageApi.new
113
+
114
+ body = PureCloud::ApiUsageQuery.new # ApiUsageQuery | Query
115
+
116
+
117
+ begin
118
+ #Query organization API Usage -
119
+ result = api_instance.post_usage_query(body)
120
+ p result
121
+ rescue PureCloud::ApiError => e
122
+ puts "Exception when calling UsageApi->post_usage_query: #{e}"
123
+ end
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ Name | Type | Description | Notes
129
+ ------------- | ------------- | ------------- | -------------
130
+ **body** | [**ApiUsageQuery**](ApiUsageQuery.html)| Query | |
131
+ {: class="table table-striped"}
132
+
133
+
134
+ ### Return type
135
+
136
+ [**UsageExecutionResult**](UsageExecutionResult.html)
137
+
138
+ ### HTTP request headers
139
+
140
+ - **Content-Type**: application/json
141
+ - **Accept**: application/json
142
+
143
+
144
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: UsageExecutionResult
3
+ ---
4
+ ## PureCloud::UsageExecutionResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **execution_id** | **String** | The id of the query execution | [optional] |
11
+ | **results_uri** | **String** | URI where the query results can be retrieved | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -9,7 +9,7 @@ title: UserAggregationQuery
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
11
11
  | **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
12
- | **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
12
+ | **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
13
13
  | **group_by** | **Array&lt;String&gt;** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
14
14
  | **filter** | [**UserAggregateQueryFilter**](UserAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
15
15
  | **metrics** | **Array&lt;String&gt;** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
@@ -17,6 +17,7 @@ title: UserQueue
17
17
  | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
18
18
  | **member_count** | **Integer** | The number of users in the queue. | [optional] |
19
19
  | **media_settings** | [**Hash&lt;String, MediaSetting&gt;**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
20
+ | **routing_rules** | [**Array&lt;RoutingRule&gt;**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
20
21
  | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
21
22
  | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
22
23
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
@@ -1145,11 +1145,11 @@ Name | Type | Description | Notes
1145
1145
 
1146
1146
  ## [**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
1147
1147
 
1148
-
1148
+ <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
1149
1149
 
1150
1150
  Get a user profile listing
1151
1151
 
1152
-
1152
+ This api is deprecated. User /api/v2/users
1153
1153
 
1154
1154
  Wraps GET /api/v2/profiles/users
1155
1155
 
@@ -1761,11 +1761,11 @@ Name | Type | Description | Notes
1761
1761
 
1762
1762
  ## [**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
1763
1763
 
1764
-
1764
+ <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
1765
1765
 
1766
1766
  Get user profile
1767
1767
 
1768
-
1768
+ This api has been deprecated. Use api/v2/users instead
1769
1769
 
1770
1770
  Wraps GET /api/v2/users/{userId}/profile
1771
1771
 
@@ -1810,7 +1810,7 @@ end
1810
1810
  Name | Type | Description | Notes
1811
1811
  ------------- | ------------- | ------------- | -------------
1812
1812
  **user_id** | **String**| userId | |
1813
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
1813
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team |
1814
1814
  {: class="table table-striped"}
1815
1815
 
1816
1816