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
@@ -10,6 +10,7 @@ title: AuditQueryRequest
10
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
11
  | **service_name** | **String** | Name of the service to query audits for. | |
12
12
  | **filters** | [**Array<AuditQueryFilter>**](AuditQueryFilter.html) | Additional filters for the query. | [optional] |
13
+ | **sort** | [**Array<AuditQuerySort>**](AuditQuerySort.html) | Sort parameter for the query. | [optional] |
13
14
  {: class="table table-striped"}
14
15
 
15
16
 
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: AuditQueryService
3
+ ---
4
+ ## PureCloud::AuditQueryService
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | Name of the Service | [optional] |
11
+ | **entities** | [**Array<AuditQueryEntity>**](AuditQueryEntity.html) | List of Entities | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: AuditQueryServiceMapping
3
+ ---
4
+ ## PureCloud::AuditQueryServiceMapping
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **services** | [**Array<AuditQueryService>**](AuditQueryService.html) | List of Services | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: AuditQuerySort
3
+ ---
4
+ ## PureCloud::AuditQuerySort
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | Name of the property to sort. | |
11
+ | **sort_order** | **String** | Sort Order | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -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
+
@@ -13,6 +13,8 @@ title: BuAgentScheduleActivity
13
13
  | **activity_code_id** | **String** | The ID of the activity code associated with this activity | [optional] |
14
14
  | **paid** | **BOOLEAN** | Whether this activity is paid | [optional] |
15
15
  | **time_off_request_id** | **String** | The ID of the time off request associated with this activity, if applicable | [optional] |
16
+ | **external_activity_id** | **String** | The ID of the external activity associated with this activity, if applicable | [optional] |
17
+ | **external_activity_type** | **String** | The type of the external activity associated with this activity, if applicable | [optional] |
16
18
  {: class="table table-striped"}
17
19
 
18
20
 
@@ -7,8 +7,8 @@ title: BuRescheduleRequest
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **start_date** | **DateTime** | The start of the range to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
11
- | **end_date** | **DateTime** | The end of the range to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
10
+ | **start_date** | **DateTime** | The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
+ | **end_date** | **DateTime** | The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
12
  | **agent_ids** | **Array<String>** | The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored | [optional] |
13
13
  | **activity_code_ids** | **Array<String>** | The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes | [optional] |
14
14
  | **management_unit_ids** | **Array<String>** | The IDs of the management units to reschedule | |
@@ -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
+
@@ -497,7 +497,7 @@ Name | Type | Description | Notes
497
497
  **interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional] |
498
498
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
499
499
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
500
- **statuses** | [**Array&lt;String&gt;**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
500
+ **statuses** | [**Array&lt;String&gt;**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed, InvalidSchedule |
501
501
  **facilitator_ids** | [**Array&lt;String&gt;**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
502
502
  **sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
503
503
  {: class="table table-striped"}
@@ -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&#39;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&#39;s specific command | [optional] |
14
+ | **context** | **Hash&lt;String, Object&gt;** | 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&lt;ButtonComponent&gt;**](ButtonComponent.html) | An array of component objects | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -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&lt;ListItemComponent&gt;**](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, &#39;namespace@name&#39; | [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 \&quot;Message\&quot; which sends a message using the quick reply text. | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -9,7 +9,7 @@ title: ConversationAggregationQuery
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** | [**ConversationAggregateQueryFilter**](ConversationAggregateQueryFilter.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: CreateQueueRequest
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] |
@@ -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 \&quot;EDGE\&quot; to use for edge-to-edge communication. | |
23
24
  | **phone_trunk_bases** | [**Array&lt;TrunkBase&gt;**](TrunkBase.html) | Trunk base settings of trunkType \&quot;PHONE\&quot; to inherit to edge logical interface for phone communication. | |
24
25
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -7,11 +7,7 @@ title: EntityListing
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array&lt;DataTableImportJob&gt;**](DataTableImportJob.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **page_count** | **Integer** | | [optional] |
10
+ | **entities** | **Array&lt;Object&gt;** | | [optional] |
15
11
  {: class="table table-striped"}
16
12
 
17
13
 
@@ -9,7 +9,7 @@ title: EvaluationAggregationQuery
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** | [**EvaluationAggregateQueryFilter**](EvaluationAggregateQueryFilter.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] |
@@ -30,6 +30,8 @@ title: ExternalContact
30
30
  | **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) | | [optional] |
31
31
  | **survey_opt_out** | **BOOLEAN** | | [optional] |
32
32
  | **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
33
+ | **schema** | [**DataSchema**](DataSchema.html) | The schema defining custom fields for this contact | [optional] |
34
+ | **custom_fields** | **Hash&lt;String, Object&gt;** | Custom fields defined in the schema referenced by schemaId and schemaVersion. | [optional] |
33
35
  | **external_data_sources** | [**Array&lt;ExternalDataSource&gt;**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
34
36
  | **self_uri** | **String** | The URI for this object | [optional] |
35
37
  {: class="table table-striped"}
@@ -25,6 +25,8 @@ title: ExternalOrganization
25
25
  | **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
26
26
  | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
27
27
  | **trustor** | [**Trustor**](Trustor.html) | | [optional] |
28
+ | **schema** | [**DataSchema**](DataSchema.html) | The schema defining custom fields for this contact | [optional] |
29
+ | **custom_fields** | **Hash&lt;String, Object&gt;** | Custom fields defined in the schema referenced by schemaId and schemaVersion. | [optional] |
28
30
  | **external_data_sources** | [**Array&lt;ExternalDataSource&gt;**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
29
31
  | **self_uri** | **String** | The URI for this object | [optional] |
30
32
  {: class="table table-striped"}
@@ -9,7 +9,7 @@ title: FlowAggregationQuery
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** | [**FlowAggregateQueryFilter**](FlowAggregateQueryFilter.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] |
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: FlowExecutionLaunchRequest
3
+ ---
4
+ ## PureCloud::FlowExecutionLaunchRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **flow_id** | **String** | ID of the flow to launch. | |
11
+ | **flow_version** | **String** | The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version. | [optional] |
12
+ | **input_data** | **Hash&lt;String, Object&gt;** | Input values to the flow. Valid values are defined by a flow&#39;s input JSON schema. | [optional] |
13
+ | **name** | **String** | A displayable name to assign to the new flow execution | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: FlowExecutionLaunchResponse
3
+ ---
4
+ ## PureCloud::FlowExecutionLaunchResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The flow execution ID | [optional] |
11
+ | **name** | **String** | The flow execution name. | [optional] |
12
+ | **flow_version** | [**DomainEntityRef**](DomainEntityRef.html) | The version of the flow that launched | [optional] |
13
+ | **self_uri** | **String** | The URI for this object | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: FlowRuntimeExecution
3
+ ---
4
+ ## PureCloud::FlowRuntimeExecution
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The flow execution ID | [optional] |
11
+ | **name** | **String** | The flow execution name. | [optional] |
12
+ | **flow_version** | [**FlowVersion**](FlowVersion.html) | The Version of the flow definition of the flow execution. | |
13
+ | **date_launched** | **DateTime** | The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
14
+ | **status** | **String** | The flow&#39;s running status, which indicates whether the flow is running normally or completed, etc. | |
15
+ | **date_completed** | **DateTime** | The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **completion_reason** | **String** | The completion reason set at the flow completion time, if applicable. | [optional] |
17
+ | **flow_error_info** | [**ErrorBody**](ErrorBody.html) | Additional information if the flow is in error | [optional] |
18
+ | **output_data** | **Hash&lt;String, Object&gt;** | List of the flow&#39;s output variables, if any. Output variables are only supplied for Completed flows. | [optional] |
19
+ | **conversation** | [**DomainEntityRef**](DomainEntityRef.html) | The conversation to which this Flow execution is related | [optional] |
20
+ | **self_uri** | **String** | The URI for this object | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: GenericSAML
3
+ ---
4
+ ## PureCloud::GenericSAML
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **logo_image_data** | **String** | | [optional] |
13
+ | **relying_party_identifier** | **String** | | [optional] |
14
+ | **endpoint_compression** | **BOOLEAN** | | [optional] |
15
+ | **certificate** | **String** | | [optional] |
16
+ | **issuer_uri** | **String** | | [optional] |
17
+ | **sso_target_uri** | **String** | | [optional] |
18
+ | **disabled** | **BOOLEAN** | | [optional] |
19
+ | **self_uri** | **String** | The URI for this object | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -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
+