purecloudplatformclientv2 75.1.0 → 79.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActivityCode.md +1 -1
  4. data/docs/AnalyticsApi.md +66 -2
  5. data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
  6. data/docs/AnalyticsConversationQueryResponse.md +1 -1
  7. data/docs/AnalyticsParticipant.md +1 -0
  8. data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
  9. data/docs/ArchitectApi.md +345 -0
  10. data/docs/AuditApi.md +3 -1
  11. data/docs/AuditLogMessage.md +1 -1
  12. data/docs/AuthorizationApi.md +154 -9
  13. data/docs/AvailableTopic.md +3 -1
  14. data/docs/BuAgentScheduleActivity.md +18 -0
  15. data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
  16. data/docs/BuAgentScheduleSearchResponse.md +15 -0
  17. data/docs/BuAgentScheduleShift.md +18 -0
  18. data/docs/BuAgentSchedulesSearchResponse.md +15 -0
  19. data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
  20. data/docs/BuFullDayTimeOffMarker.md +18 -0
  21. data/docs/BuScheduleReference.md +15 -0
  22. data/docs/Call.md +1 -1
  23. data/docs/CallBasic.md +1 -1
  24. data/docs/CallMediaParticipant.md +1 -1
  25. data/docs/CallbackMediaParticipant.md +1 -1
  26. data/docs/CampaignProgress.md +2 -1
  27. data/docs/ChatMediaParticipant.md +1 -1
  28. data/docs/CobrowseMediaParticipant.md +1 -1
  29. data/docs/ConversationsApi.md +71 -1
  30. data/docs/CopyAttachmentsRequest.md +14 -0
  31. data/docs/CreateManagementUnitApiRequest.md +3 -2
  32. data/docs/CreateManagementUnitSettingsRequest.md +1 -1
  33. data/docs/CreateWorkPlanShift.md +1 -1
  34. data/docs/DataTableExportJob.md +22 -0
  35. data/docs/DataTableImportJob.md +25 -0
  36. data/docs/DivsPermittedEntityListing.md +23 -0
  37. data/docs/EmailMediaParticipant.md +1 -1
  38. data/docs/EntityListing.md +17 -0
  39. data/docs/ErrorBody.md +2 -2
  40. data/docs/ErrorInfo.md +14 -0
  41. data/docs/Evaluation.md +1 -0
  42. data/docs/EvaluationQuestionGroupScore.md +4 -0
  43. data/docs/EvaluationScoringSet.md +1 -0
  44. data/docs/FacebookIntegrationRequest.md +2 -2
  45. data/docs/GDPRJourneyCustomer.md +2 -2
  46. data/docs/InboundDomain.md +2 -0
  47. data/docs/Library.md +4 -3
  48. data/docs/LicenseApi.md +66 -0
  49. data/docs/MailFromResult.md +15 -0
  50. data/docs/ManagementUnit.md +2 -2
  51. data/docs/ManagementUnitSettingsRequest.md +1 -1
  52. data/docs/MessageMediaParticipant.md +1 -1
  53. data/docs/MessagingApi.md +0 -936
  54. data/docs/MessagingTemplate.md +15 -0
  55. data/docs/Organization.md +1 -0
  56. data/docs/QualityApi.md +5 -6
  57. data/docs/Record.md +15 -0
  58. data/docs/ReportingExportMetadataJobListing.md +22 -0
  59. data/docs/ReportingExportMetadataJobResponse.md +22 -0
  60. data/docs/Response.md +2 -0
  61. data/docs/RoutingApi.md +385 -0
  62. data/docs/RoutingSettings.md +13 -0
  63. data/docs/SCIMApi.md +397 -23
  64. data/docs/ScimUserExtensions.md +14 -0
  65. data/docs/ScimUserRole.md +13 -0
  66. data/docs/ScimUserRoutingLanguage.md +14 -0
  67. data/docs/ScimUserRoutingSkill.md +14 -0
  68. data/docs/ScimV2CreateUser.md +2 -1
  69. data/docs/ScimV2SchemaAttribute.md +24 -0
  70. data/docs/ScimV2SchemaDefinition.md +17 -0
  71. data/docs/ScimV2SchemaListResponse.md +17 -0
  72. data/docs/ScimV2User.md +2 -1
  73. data/docs/ShortTermForecast.md +2 -2
  74. data/docs/ShortTermForecastListItemResponse.md +2 -2
  75. data/docs/ShortTermForecastReference.md +2 -2
  76. data/docs/TimeOffRequestLookup.md +3 -3
  77. data/docs/TimeOffRequestResponse.md +3 -3
  78. data/docs/UserScheduleAdherence.md +1 -1
  79. data/docs/UsersApi.md +358 -10
  80. data/docs/ViewFilter.md +4 -10
  81. data/docs/WeekSchedule.md +1 -1
  82. data/docs/WeekScheduleListItemResponse.md +1 -1
  83. data/docs/WeekScheduleReference.md +1 -1
  84. data/docs/WorkPlanShift.md +1 -1
  85. data/docs/WorkforceManagementApi.md +40 -41
  86. data/lib/purecloudplatformclientv2.rb +27 -0
  87. data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
  88. data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
  89. data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
  90. data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
  91. data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
  92. data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
  93. data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
  94. data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
  95. data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
  96. data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
  101. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
  102. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
  103. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
  104. data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
  106. data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
  107. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
  108. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
  110. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
  111. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
  112. data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
  113. data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
  114. data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
  115. data/lib/purecloudplatformclientv2/models/call.rb +1 -1
  116. data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
  117. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
  118. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
  119. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
  120. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
  121. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
  122. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  123. data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
  124. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
  125. data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
  126. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
  127. data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
  128. data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
  129. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
  130. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
  131. data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
  132. data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
  133. data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
  134. data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
  135. data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
  136. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
  137. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
  138. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  139. data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
  140. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
  141. data/lib/purecloudplatformclientv2/models/library.rb +44 -2
  142. data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
  143. data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
  144. data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
  145. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
  146. data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
  147. data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
  148. data/lib/purecloudplatformclientv2/models/record.rb +269 -0
  149. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  150. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
  151. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
  152. data/lib/purecloudplatformclientv2/models/response.rb +67 -1
  153. data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
  154. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  155. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
  156. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
  157. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
  158. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
  159. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
  160. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
  161. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
  162. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
  163. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
  164. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
  165. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
  166. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  167. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
  168. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
  169. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
  170. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
  171. data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
  172. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
  173. data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
  174. data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
  175. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
  176. data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
  177. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +56 -2
@@ -24,7 +24,7 @@ title: CobrowseMediaParticipant
24
24
  | **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
25
25
  | **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
26
26
  | **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
27
- | **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
27
+ | **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
28
28
  | **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
29
29
  | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
30
30
  | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
@@ -122,6 +122,7 @@ Method | Description
122
122
  [**post_conversations_cobrowsesession_participant_replace**](ConversationsApi.html#post_conversations_cobrowsesession_participant_replace) | Replace this participant with the specified user and/or address
123
123
  [**post_conversations_email_inboundmessages**](ConversationsApi.html#post_conversations_email_inboundmessages) | Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
124
124
  [**post_conversations_email_messages**](ConversationsApi.html#post_conversations_email_messages) | Send an email reply
125
+ [**post_conversations_email_messages_draft_attachments_copy**](ConversationsApi.html#post_conversations_email_messages_draft_attachments_copy) | Copy attachments from an email message to the current draft.
125
126
  [**post_conversations_email_participant_replace**](ConversationsApi.html#post_conversations_email_participant_replace) | Replace this participant with the specified user and/or address
126
127
  [**post_conversations_emails**](ConversationsApi.html#post_conversations_emails) | Create an email conversation
127
128
  [**post_conversations_faxes**](ConversationsApi.html#post_conversations_faxes) | Create Fax Conversation
@@ -962,7 +963,8 @@ api_instance = PureCloud::ConversationsApi.new
962
963
  job_id = "job_id_example" # String | jobId
963
964
 
964
965
  opts = {
965
- cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
966
+ cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
967
+ page_size: 56 # Integer | The desired maximum number of results
966
968
  }
967
969
 
968
970
  begin
@@ -980,6 +982,7 @@ Name | Type | Description | Notes
980
982
  ------------- | ------------- | ------------- | -------------
981
983
  **job_id** | **String**| jobId | |
982
984
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
985
+ **page_size** | **Integer**| The desired maximum number of results | [optional] |
983
986
  {: class="table table-striped"}
984
987
 
985
988
 
@@ -7811,6 +7814,73 @@ Name | Type | Description | Notes
7811
7814
 
7812
7815
 
7813
7816
 
7817
+ <a name="post_conversations_email_messages_draft_attachments_copy"></a>
7818
+
7819
+ ## [**EmailMessage**](EmailMessage.html) post_conversations_email_messages_draft_attachments_copy(conversation_id, body)
7820
+
7821
+
7822
+
7823
+ Copy attachments from an email message to the current draft.
7824
+
7825
+
7826
+
7827
+ Wraps POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy
7828
+
7829
+ Requires NO permissions:
7830
+
7831
+
7832
+
7833
+ ### Example
7834
+ ```{"language":"ruby"}
7835
+ # load the gem
7836
+ require 'purecloudplatformclientv2'
7837
+ # setup authorization
7838
+ @secret = ENV['PURECLOUD_SECRET']
7839
+ @id = ENV['PURECLOUD_CLIENT_ID']
7840
+ environment = "mypurecloud.com"
7841
+
7842
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
7843
+
7844
+ PureCloud.configure do |config|
7845
+ config.access_token = @authToken
7846
+ end
7847
+
7848
+ api_instance = PureCloud::ConversationsApi.new
7849
+
7850
+ conversation_id = "conversation_id_example" # String | conversationId
7851
+
7852
+ body = PureCloud::CopyAttachmentsRequest.new # CopyAttachmentsRequest | Copy Attachment Request
7853
+
7854
+
7855
+ begin
7856
+ #Copy attachments from an email message to the current draft.
7857
+ result = api_instance.post_conversations_email_messages_draft_attachments_copy(conversation_id, body)
7858
+ p result
7859
+ rescue PureCloud::ApiError => e
7860
+ puts "Exception when calling ConversationsApi->post_conversations_email_messages_draft_attachments_copy: #{e}"
7861
+ end
7862
+ ```
7863
+
7864
+ ### Parameters
7865
+
7866
+ Name | Type | Description | Notes
7867
+ ------------- | ------------- | ------------- | -------------
7868
+ **conversation_id** | **String**| conversationId | |
7869
+ **body** | [**CopyAttachmentsRequest**](CopyAttachmentsRequest.html)| Copy Attachment Request | |
7870
+ {: class="table table-striped"}
7871
+
7872
+
7873
+ ### Return type
7874
+
7875
+ [**EmailMessage**](EmailMessage.html)
7876
+
7877
+ ### HTTP request headers
7878
+
7879
+ - **Content-Type**: application/json
7880
+ - **Accept**: application/json
7881
+
7882
+
7883
+
7814
7884
  <a name="post_conversations_email_participant_replace"></a>
7815
7885
 
7816
7886
  ## post_conversations_email_participant_replace(conversation_id, participant_id, body)
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: CopyAttachmentsRequest
3
+ ---
4
+ ## PureCloud::CopyAttachmentsRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **source_message** | [**DomainEntityRef**](DomainEntityRef.html) | A reference to the email message within the current conversation that owns the attachments to be copied | |
11
+ | **attachments** | [**Array&lt;Attachment&gt;**](Attachment.html) | A list of attachments that will be copied from the source message to the current draft | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -8,10 +8,11 @@ title: CreateManagementUnitApiRequest
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **name** | **String** | The name of the management unit | |
11
- | **time_zone** | **String** | The default time zone to use for this management unit | |
12
- | **start_day_of_week** | **String** | The configured first day of the week for scheduling and forecasting purposes | |
11
+ | **time_zone** | **String** | The default time zone to use for this management unit. Moving to Business Unit | [optional] |
12
+ | **start_day_of_week** | **String** | The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit | [optional] |
13
13
  | **settings** | [**CreateManagementUnitSettingsRequest**](CreateManagementUnitSettingsRequest.html) | The configuration for the management unit. If omitted, reasonable defaults will be assigned | [optional] |
14
14
  | **division_id** | **String** | The id of the division to which this management unit belongs. Defaults to home division ID | [optional] |
15
+ | **business_unit_id** | **String** | The id of the business unit to which this management unit belongs. Required after business unit launch | |
15
16
  {: class="table table-striped"}
16
17
 
17
18
 
@@ -8,7 +8,7 @@ title: CreateManagementUnitSettingsRequest
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
11
- | **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
11
+ | **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit. Moving to Business Unit | [optional] |
12
12
  | **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
13
13
  | **scheduling** | [**SchedulingSettingsRequest**](SchedulingSettingsRequest.html) | Scheduling settings for this management unit | [optional] |
14
14
  | **shift_trading** | [**ShiftTradeSettings**](ShiftTradeSettings.html) | Shift trade settings for this management unit | [optional] |
@@ -13,7 +13,7 @@ title: CreateWorkPlanShift
13
13
  | **exact_start_time_minutes_from_midnight** | **Integer** | Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false | [optional] |
14
14
  | **earliest_start_time_minutes_from_midnight** | **Integer** | Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
15
15
  | **latest_start_time_minutes_from_midnight** | **Integer** | Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
16
- | **constrain_stop_time** | **BOOLEAN** | Whether the latest stop time constraint for the shift is enabled | [optional] |
16
+ | **constrain_stop_time** | **BOOLEAN** | Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead | [optional] |
17
17
  | **constrain_latest_stop_time** | **BOOLEAN** | Whether the latest stop time constraint for the shift is enabled | [optional] |
18
18
  | **latest_stop_time_minutes_from_midnight** | **Integer** | Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true | [optional] |
19
19
  | **start_increment_minutes** | **Integer** | Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true | [optional] |
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: DataTableExportJob
3
+ ---
4
+ ## PureCloud::DataTableExportJob
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
+ | **owner** | [**AddressableEntityRef**](AddressableEntityRef.html) | The PureCloud user who started the export job | [optional] |
13
+ | **status** | **String** | The status of the export job | |
14
+ | **date_created** | **DateTime** | The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_completed** | **DateTime** | The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **download_uri** | **String** | The URL of the location at which the caller can download the export file, when available | [optional] |
17
+ | **error_information** | [**ErrorBody**](ErrorBody.html) | Any error information, or null of the processing is not in an error state | [optional] |
18
+ | **count_records_processed** | **Integer** | The current count of the number of records processed | [optional] |
19
+ | **self_uri** | **String** | The URI for this object | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: DataTableImportJob
3
+ ---
4
+ ## PureCloud::DataTableImportJob
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
+ | **owner** | [**AddressableEntityRef**](AddressableEntityRef.html) | The PureCloud user who started the import job | [optional] |
13
+ | **status** | **String** | The status of the import job | |
14
+ | **date_created** | **DateTime** | The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_completed** | **DateTime** | The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **upload_uri** | **String** | The URL of the location at which the caller can upload the file to be imported | [optional] |
17
+ | **import_mode** | **String** | The indication of whether the processing should remove rows that don&#39;t appear in the import file | [optional] |
18
+ | **error_information** | [**ErrorBody**](ErrorBody.html) | Any error information, or null of the processing is not in an error state | [optional] |
19
+ | **count_records_updated** | **Integer** | The current count of the number of records processed | [optional] |
20
+ | **count_records_deleted** | **Integer** | The current count of the number of records deleted | [optional] |
21
+ | **count_records_failed** | **Integer** | The current count of the number of records that failed to import | [optional] |
22
+ | **self_uri** | **String** | The URI for this object | [optional] |
23
+ {: class="table table-striped"}
24
+
25
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: DivsPermittedEntityListing
3
+ ---
4
+ ## PureCloud::DivsPermittedEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;AuthzDivision&gt;**](AuthzDivision.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **all_divs_permitted** | **BOOLEAN** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **self_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
+ | **last_uri** | **String** | | [optional] |
20
+ | **page_count** | **Integer** | | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -24,7 +24,7 @@ title: EmailMediaParticipant
24
24
  | **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
25
25
  | **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
26
26
  | **attributes** | **Hash&lt;String, String&gt;** | A list of ad-hoc attributes for the participant. | [optional] |
27
- | **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
27
+ | **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
28
28
  | **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
29
29
  | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
30
30
  | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: EntityListing
3
+ ---
4
+ ## PureCloud::EntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
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] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -7,11 +7,11 @@ title: ErrorBody
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **status** | **Integer** | | [optional] |
10
+ | **message** | **String** | | [optional] |
11
11
  | **code** | **String** | | [optional] |
12
+ | **status** | **Integer** | | [optional] |
12
13
  | **entity_id** | **String** | | [optional] |
13
14
  | **entity_name** | **String** | | [optional] |
14
- | **message** | **String** | | [optional] |
15
15
  | **message_with_params** | **String** | | [optional] |
16
16
  | **message_params** | **Hash&lt;String, String&gt;** | | [optional] |
17
17
  | **context_id** | **String** | | [optional] |
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: ErrorInfo
3
+ ---
4
+ ## PureCloud::ErrorInfo
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **message** | **String** | | [optional] |
11
+ | **code** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -24,6 +24,7 @@ title: Evaluation
24
24
  | **media_type** | **Array&lt;String&gt;** | List of different communication types used in conversation. | [optional] |
25
25
  | **rescore** | **BOOLEAN** | Is only true when evaluation is re-scored. | [optional] |
26
26
  | **conversation_date** | **DateTime** | Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
27
+ | **conversation_end_date** | **DateTime** | End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
27
28
  | **never_release** | **BOOLEAN** | Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. | [optional] |
28
29
  | **resource_id** | **String** | Only used for email evaluations. Will be null for all other evaluations. | [optional] |
29
30
  | **resource_type** | **String** | The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. | [optional] |
@@ -13,10 +13,14 @@ title: EvaluationQuestionGroupScore
13
13
  | **marked_na** | **BOOLEAN** | | [optional] |
14
14
  | **total_critical_score** | **Float** | | [optional] |
15
15
  | **max_total_critical_score** | **Float** | | [optional] |
16
+ | **total_non_critical_score** | **Float** | | [optional] |
17
+ | **max_total_non_critical_score** | **Float** | | [optional] |
16
18
  | **total_score_unweighted** | **Float** | | [optional] |
17
19
  | **max_total_score_unweighted** | **Float** | | [optional] |
18
20
  | **total_critical_score_unweighted** | **Float** | | [optional] |
19
21
  | **max_total_critical_score_unweighted** | **Float** | | [optional] |
22
+ | **total_non_critical_score_unweighted** | **Float** | | [optional] |
23
+ | **max_total_non_critical_score_unweighted** | **Float** | | [optional] |
20
24
  | **question_scores** | [**Array&lt;EvaluationQuestionScore&gt;**](EvaluationQuestionScore.html) | | [optional] |
21
25
  {: class="table table-striped"}
22
26
 
@@ -9,6 +9,7 @@ title: EvaluationScoringSet
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **total_score** | **Float** | | [optional] |
11
11
  | **total_critical_score** | **Float** | | [optional] |
12
+ | **total_non_critical_score** | **Float** | | [optional] |
12
13
  | **question_group_scores** | [**Array&lt;EvaluationQuestionGroupScore&gt;**](EvaluationQuestionGroupScore.html) | | [optional] |
13
14
  | **any_failed_kill_questions** | **BOOLEAN** | | [optional] |
14
15
  | **comments** | **String** | | [optional] |
@@ -12,8 +12,8 @@ title: FacebookIntegrationRequest
12
12
  | **page_access_token** | **String** | The long-lived Page Access Token of a facebook page. See https://developers.facebook.com/docs/facebook-login/access-tokens. When a pageAccessToken is provided, pageId and userAccessToken are not required. | [optional] |
13
13
  | **user_access_token** | **String** | The short-lived User Access Token of the facebook user logged into the facebook app. See https://developers.facebook.com/docs/facebook-login/access-tokens. When userAccessToken is provided, pageId is mandatory. When userAccessToken/pageId combination is provided, pageAccessToken is not required. | [optional] |
14
14
  | **page_id** | **String** | The page Id of a facebook page. The pageId is required when userAccessToken is provided. | [optional] |
15
- | **app_id** | **String** | The app Id of a facebook app | |
16
- | **app_secret** | **String** | The app Secret of a facebook app | [optional] |
15
+ | **app_id** | **String** | The app Id of a facebook app. The appId is required when a customer wants to use their own approved facebook app. | [optional] |
16
+ | **app_secret** | **String** | The app Secret of a facebook app. The appSecret is required when appId is provided. | [optional] |
17
17
  | **self_uri** | **String** | The URI for this object | [optional] |
18
18
  {: class="table table-striped"}
19
19
 
@@ -7,8 +7,8 @@ title: GDPRJourneyCustomer
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **type** | **String** | The type of the customerId within the Journey System (e.g. cookie). | |
11
- | **id** | **String** | An ID of a customer within the Journey System at a point-in-time. | |
10
+ | **type** | **String** | The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined. | [optional] |
11
+ | **id** | **String** | An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined. | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
@@ -11,6 +11,8 @@ title: InboundDomain
11
11
  | **name** | **String** | | [optional] |
12
12
  | **mx_record_status** | **String** | Mx Record Status | |
13
13
  | **sub_domain** | **BOOLEAN** | Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email. | [optional] |
14
+ | **mail_from_settings** | [**MailFromResult**](MailFromResult.html) | The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false. | [optional] |
15
+ | **custom_smtp_server** | [**DomainEntityRef**](DomainEntityRef.html) | The custom SMTP server integration to use when sending outbound emails from this domain. | [optional] |
14
16
  | **self_uri** | **String** | The URI for this object | [optional] |
15
17
  {: class="table table-striped"}
16
18
 
@@ -9,9 +9,10 @@ title: Library
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | The library name. | |
12
- | **version** | **Integer** | | [optional] |
13
- | **created_by** | [**User**](User.html) | | [optional] |
14
- | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
+ | **version** | **Integer** | Current version for this resource. | [optional] |
13
+ | **created_by** | [**User**](User.html) | User that created the library. | [optional] |
14
+ | **date_created** | **DateTime** | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **response_type** | **String** | The response type for the library. If set, only response&#39;s of this type may be added to this library. | [optional] |
15
16
  | **self_uri** | **String** | The URI for this object | [optional] |
16
17
  {: class="table table-striped"}
17
18
 
@@ -13,6 +13,7 @@ Method | Description
13
13
  [**get_license_toggle**](LicenseApi.html#get_license_toggle) | Get PureCloud license feature toggle value.
14
14
  [**get_license_user**](LicenseApi.html#get_license_user) | Get licenses for specified user.
15
15
  [**get_license_users**](LicenseApi.html#get_license_users) | Get a page of users and their licenses
16
+ [**post_license_infer**](LicenseApi.html#post_license_infer) | Get a list of licenses inferred based on a list of roleIds
16
17
  [**post_license_organization**](LicenseApi.html#post_license_organization) | Update the organization&#39;s license assignments in a batch.
17
18
  [**post_license_toggle**](LicenseApi.html#post_license_toggle) | Switch PureCloud license feature toggle value.
18
19
  [**post_license_users**](LicenseApi.html#post_license_users) | Fetch user licenses in a batch.
@@ -339,6 +340,71 @@ Name | Type | Description | Notes
339
340
 
340
341
 
341
342
 
343
+ <a name="post_license_infer"></a>
344
+
345
+ ## Array&lt;String&gt;** post_license_infer(opts)
346
+
347
+
348
+
349
+ Get a list of licenses inferred based on a list of roleIds
350
+
351
+
352
+
353
+ Wraps POST /api/v2/license/infer
354
+
355
+ Requires NO permissions:
356
+
357
+
358
+
359
+ ### Example
360
+ ```{"language":"ruby"}
361
+ # load the gem
362
+ require 'purecloudplatformclientv2'
363
+ # setup authorization
364
+ @secret = ENV['PURECLOUD_SECRET']
365
+ @id = ENV['PURECLOUD_CLIENT_ID']
366
+ environment = "mypurecloud.com"
367
+
368
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
369
+
370
+ PureCloud.configure do |config|
371
+ config.access_token = @authToken
372
+ end
373
+
374
+ api_instance = PureCloud::LicenseApi.new
375
+
376
+ opts = {
377
+ body: [PureCloud::Array<String>.new] # Array<String> | The roleIds to use while inferring licenses
378
+ }
379
+
380
+ begin
381
+ #Get a list of licenses inferred based on a list of roleIds
382
+ result = api_instance.post_license_infer(opts)
383
+ p result
384
+ rescue PureCloud::ApiError => e
385
+ puts "Exception when calling LicenseApi->post_license_infer: #{e}"
386
+ end
387
+ ```
388
+
389
+ ### Parameters
390
+
391
+ Name | Type | Description | Notes
392
+ ------------- | ------------- | ------------- | -------------
393
+ **body** | **Array&lt;String&gt;**| The roleIds to use while inferring licenses | [optional] |
394
+ {: class="table table-striped"}
395
+
396
+
397
+ ### Return type
398
+
399
+ **Array&lt;String&gt;**
400
+
401
+ ### HTTP request headers
402
+
403
+ - **Content-Type**: application/json
404
+ - **Accept**: application/json
405
+
406
+
407
+
342
408
  <a name="post_license_organization"></a>
343
409
 
344
410
  ## [**Array&lt;LicenseUpdateStatus&gt;**](LicenseUpdateStatus.html) post_license_organization(opts)