purecloudplatformclientv2 75.0.0 → 78.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) 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/ArrayNode.md +2 -2
  6. data/docs/Call.md +1 -1
  7. data/docs/CallBasic.md +1 -1
  8. data/docs/CallMediaParticipant.md +1 -1
  9. data/docs/CallbackMediaParticipant.md +1 -1
  10. data/docs/ChatMediaParticipant.md +1 -1
  11. data/docs/CobrowseMediaParticipant.md +1 -1
  12. data/docs/ConversationsApi.md +74 -4
  13. data/docs/CopyAttachmentsRequest.md +14 -0
  14. data/docs/CreateManagementUnitApiRequest.md +3 -2
  15. data/docs/CreateManagementUnitSettingsRequest.md +1 -1
  16. data/docs/CreateWorkPlanShift.md +1 -1
  17. data/docs/EdgeNetworkDiagnostic.md +14 -0
  18. data/docs/EdgeNetworkDiagnosticRequest.md +13 -0
  19. data/docs/EdgeNetworkDiagnosticResponse.md +14 -0
  20. data/docs/EmailMediaParticipant.md +1 -1
  21. data/docs/ErrorBody.md +2 -2
  22. data/docs/ErrorInfo.md +14 -0
  23. data/docs/Evaluation.md +1 -0
  24. data/docs/FacebookIntegrationRequest.md +2 -2
  25. data/docs/GDPRJourneyCustomer.md +2 -2
  26. data/docs/InboundDomain.md +2 -0
  27. data/docs/JsonNode.md +2 -2
  28. data/docs/Library.md +4 -3
  29. data/docs/MailFromResult.md +15 -0
  30. data/docs/ManagementUnit.md +2 -2
  31. data/docs/ManagementUnitSettingsRequest.md +1 -1
  32. data/docs/MessageMediaParticipant.md +1 -1
  33. data/docs/MessagingApi.md +84 -0
  34. data/docs/MessagingTemplate.md +15 -0
  35. data/docs/QualityApi.md +5 -6
  36. data/docs/Record.md +15 -0
  37. data/docs/ReportingExportMetadataJobListing.md +22 -0
  38. data/docs/ReportingExportMetadataJobResponse.md +22 -0
  39. data/docs/Response.md +2 -0
  40. data/docs/RoutingApi.md +184 -0
  41. data/docs/RoutingSettings.md +13 -0
  42. data/docs/SCIMApi.md +397 -23
  43. data/docs/ScimUserExtensions.md +14 -0
  44. data/docs/ScimUserRole.md +13 -0
  45. data/docs/ScimUserRoutingLanguage.md +14 -0
  46. data/docs/ScimUserRoutingSkill.md +14 -0
  47. data/docs/ScimV2CreateUser.md +2 -1
  48. data/docs/ScimV2SchemaAttribute.md +24 -0
  49. data/docs/ScimV2SchemaDefinition.md +17 -0
  50. data/docs/ScimV2SchemaListResponse.md +17 -0
  51. data/docs/ScimV2User.md +2 -1
  52. data/docs/ShortTermForecast.md +2 -2
  53. data/docs/ShortTermForecastListItemResponse.md +2 -2
  54. data/docs/ShortTermForecastReference.md +2 -2
  55. data/docs/TelephonyProvidersEdgeApi.md +540 -0
  56. data/docs/TimeOffRequestLookup.md +3 -3
  57. data/docs/TimeOffRequestResponse.md +3 -3
  58. data/docs/UserScheduleAdherence.md +1 -1
  59. data/docs/UsersApi.md +3 -1
  60. data/docs/ViewFilter.md +4 -0
  61. data/docs/WeekSchedule.md +1 -1
  62. data/docs/WeekScheduleListItemResponse.md +1 -1
  63. data/docs/WeekScheduleReference.md +1 -1
  64. data/docs/WorkPlanShift.md +1 -1
  65. data/docs/WorkforceManagementApi.md +38 -39
  66. data/lib/purecloudplatformclientv2.rb +19 -0
  67. data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
  68. data/lib/purecloudplatformclientv2/api/conversations_api.rb +88 -4
  69. data/lib/purecloudplatformclientv2/api/messaging_api.rb +110 -0
  70. data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
  71. data/lib/purecloudplatformclientv2/api/routing_api.rb +174 -0
  72. data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
  73. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +560 -0
  74. data/lib/purecloudplatformclientv2/api/users_api.rb +9 -0
  75. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  76. data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
  77. data/lib/purecloudplatformclientv2/models/array_node.rb +23 -23
  78. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +4 -4
  79. data/lib/purecloudplatformclientv2/models/call.rb +1 -1
  80. data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
  81. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
  82. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
  83. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
  84. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
  85. data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
  86. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
  87. data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
  88. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
  89. data/lib/purecloudplatformclientv2/models/edge_network_diagnostic.rb +228 -0
  90. data/lib/purecloudplatformclientv2/models/edge_network_diagnostic_request.rb +207 -0
  91. data/lib/purecloudplatformclientv2/models/edge_network_diagnostic_response.rb +228 -0
  92. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
  93. data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
  94. data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
  95. data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
  96. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
  97. data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
  98. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
  99. data/lib/purecloudplatformclientv2/models/json_node.rb +23 -23
  100. data/lib/purecloudplatformclientv2/models/library.rb +44 -2
  101. data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
  102. data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
  103. data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
  104. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
  105. data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
  106. data/lib/purecloudplatformclientv2/models/record.rb +269 -0
  107. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
  108. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
  109. data/lib/purecloudplatformclientv2/models/response.rb +67 -1
  110. data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
  111. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  112. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
  113. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
  114. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
  115. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
  116. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
  117. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
  118. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
  119. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
  120. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
  121. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
  122. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
  123. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
  124. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
  125. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
  126. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
  127. data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
  128. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
  129. data/lib/purecloudplatformclientv2/models/view_filter.rb +114 -4
  130. data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
  131. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
  132. data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
  133. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
  134. data/lib/purecloudplatformclientv2/version.rb +1 -1
  135. metadata +40 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2dcbe377445fb00ab332db5732a21effaa1c7f97
4
- data.tar.gz: fe5a6f709eab794b2d141d291c29dc7b9f577888
3
+ metadata.gz: 4372e24acd360b1205419d589df86923ef7c0add
4
+ data.tar.gz: 5138110900b2e3618a2d539c8d74bcd014ce6cd8
5
5
  SHA512:
6
- metadata.gz: a9749a9aedc3309f52063e5379c8211b7528d78efd355789a8bb40d3e8b6c95caee05c251a5653ad08f6db7fb038e3f85023d961022cc506dabef4ca325f5e6c
7
- data.tar.gz: c28d321c074d9fc2f0ce999433e18d63f1a1df55ae35494885393261427c8a01df0b7fc936133b29c7af89f3cf26066fbb7c2f5228dc83912b92256244b2fb0f
6
+ metadata.gz: 9f272b18db2f080b6c4bab823ea78e8d1137c760ac09066b80a166b60db009af2df853d2f15f4aa318b15547a68331a9886629835e005e629d5e814ae0ade53c
7
+ data.tar.gz: 55cc5031ed8a8c33f60e1bdd0158ad707cf1c961b670e7adb0603e21bbb865050aa50cc8683ff1b6e5234d583cc05ebe9b5737644074c520787a31f043240b3f
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=75.0.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=78.1.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ```{"language":"ruby"}
13
- gem install 'purecloudplatformclientv2', '~> 75.0.0'
13
+ gem install 'purecloudplatformclientv2', '~> 78.1.0'
14
14
  ```
15
15
 
16
16
  ### Install from Git
@@ -8,6 +8,7 @@ title: ActivityCode
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **self_uri** | **String** | The URI for this object | [optional] |
11
12
  | **name** | **String** | The name of the activity code. Default activity codes will be created with an empty name | [optional] |
12
13
  | **is_active** | **BOOLEAN** | Whether this activity code is active or has been deleted | [optional] |
13
14
  | **is_default** | **BOOLEAN** | Whether this is a default activity code | [optional] |
@@ -17,7 +18,6 @@ title: ActivityCode
17
18
  | **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints | [optional] |
18
19
  | **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. | [optional] |
19
20
  | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the associated management unit's list of activity codes | |
20
- | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
23
23
 
@@ -16,6 +16,7 @@ Method | Description
16
16
  [**get_analytics_conversations_details_job**](AnalyticsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
17
17
  [**get_analytics_conversations_details_job_results**](AnalyticsApi.html#get_analytics_conversations_details_job_results) | Fetch a page of results for an async query
18
18
  [**get_analytics_reporting_exports**](AnalyticsApi.html#get_analytics_reporting_exports) | Get all view export requests for a user
19
+ [**get_analytics_reporting_exports_metadata**](AnalyticsApi.html#get_analytics_reporting_exports_metadata) | Get all export metadata
19
20
  [**get_analytics_reporting_metadata**](AnalyticsApi.html#get_analytics_reporting_metadata) | Get list of reporting metadata.
20
21
  [**get_analytics_reporting_report_id_metadata**](AnalyticsApi.html#get_analytics_reporting_report_id_metadata) | Get a reporting metadata.
21
22
  [**get_analytics_reporting_reportformats**](AnalyticsApi.html#get_analytics_reporting_reportformats) | Get a list of report formats
@@ -470,7 +471,8 @@ api_instance = PureCloud::AnalyticsApi.new
470
471
  job_id = "job_id_example" # String | jobId
471
472
 
472
473
  opts = {
473
- cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
474
+ cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
475
+ page_size: 56 # Integer | The desired maximum number of results
474
476
  }
475
477
 
476
478
  begin
@@ -488,6 +490,7 @@ Name | Type | Description | Notes
488
490
  ------------- | ------------- | ------------- | -------------
489
491
  **job_id** | **String**| jobId | |
490
492
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
493
+ **page_size** | **Integer**| The desired maximum number of results | [optional] |
491
494
  {: class="table table-striped"}
492
495
 
493
496
 
@@ -561,6 +564,65 @@ This endpoint does not need any parameter.
561
564
 
562
565
 
563
566
 
567
+ <a name="get_analytics_reporting_exports_metadata"></a>
568
+
569
+ ## [**ReportingExportMetadataJobListing**](ReportingExportMetadataJobListing.html) get_analytics_reporting_exports_metadata
570
+
571
+
572
+
573
+ Get all export metadata
574
+
575
+
576
+
577
+ Wraps GET /api/v2/analytics/reporting/exports/metadata
578
+
579
+ Requires ANY permissions:
580
+
581
+ * analytics:dataExport:view
582
+
583
+
584
+ ### Example
585
+ ```{"language":"ruby"}
586
+ # load the gem
587
+ require 'purecloudplatformclientv2'
588
+ # setup authorization
589
+ @secret = ENV['PURECLOUD_SECRET']
590
+ @id = ENV['PURECLOUD_CLIENT_ID']
591
+ environment = "mypurecloud.com"
592
+
593
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
594
+
595
+ PureCloud.configure do |config|
596
+ config.access_token = @authToken
597
+ end
598
+
599
+ api_instance = PureCloud::AnalyticsApi.new
600
+
601
+ begin
602
+ #Get all export metadata
603
+ result = api_instance.get_analytics_reporting_exports_metadata
604
+ p result
605
+ rescue PureCloud::ApiError => e
606
+ puts "Exception when calling AnalyticsApi->get_analytics_reporting_exports_metadata: #{e}"
607
+ end
608
+ ```
609
+
610
+ ### Parameters
611
+ This endpoint does not need any parameter.
612
+ {: class="table table-striped"}
613
+
614
+
615
+ ### Return type
616
+
617
+ [**ReportingExportMetadataJobListing**](ReportingExportMetadataJobListing.html)
618
+
619
+ ### HTTP request headers
620
+
621
+ - **Content-Type**: application/json
622
+ - **Accept**: application/json
623
+
624
+
625
+
564
626
  <a name="get_analytics_reporting_metadata"></a>
565
627
 
566
628
  ## [**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
@@ -1250,7 +1312,8 @@ api_instance = PureCloud::AnalyticsApi.new
1250
1312
  job_id = "job_id_example" # String | jobId
1251
1313
 
1252
1314
  opts = {
1253
- cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
1315
+ cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
1316
+ page_size: 56 # Integer | The desired maximum number of results
1254
1317
  }
1255
1318
 
1256
1319
  begin
@@ -1268,6 +1331,7 @@ Name | Type | Description | Notes
1268
1331
  ------------- | ------------- | ------------- | -------------
1269
1332
  **job_id** | **String**| jobId | |
1270
1333
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
1334
+ **page_size** | **Integer**| The desired maximum number of results | [optional] |
1271
1335
  {: class="table table-striped"}
1272
1336
 
1273
1337
 
@@ -15,8 +15,9 @@ title: ArrayNode
15
15
  | **value_node** | **BOOLEAN** | | [optional] |
16
16
  | **container_node** | **BOOLEAN** | | [optional] |
17
17
  | **missing_node** | **BOOLEAN** | | [optional] |
18
- | **integral_number** | **BOOLEAN** | | [optional] |
18
+ | **pojo** | **BOOLEAN** | | [optional] |
19
19
  | **floating_point_number** | **BOOLEAN** | | [optional] |
20
+ | **integral_number** | **BOOLEAN** | | [optional] |
20
21
  | **short** | **BOOLEAN** | | [optional] |
21
22
  | **int** | **BOOLEAN** | | [optional] |
22
23
  | **long** | **BOOLEAN** | | [optional] |
@@ -25,7 +26,6 @@ title: ArrayNode
25
26
  | **big_integer** | **BOOLEAN** | | [optional] |
26
27
  | **textual** | **BOOLEAN** | | [optional] |
27
28
  | **binary** | **BOOLEAN** | | [optional] |
28
- | **pojo** | **BOOLEAN** | | [optional] |
29
29
  | **array** | **BOOLEAN** | | [optional] |
30
30
  | **null** | **BOOLEAN** | | [optional] |
31
31
  {: class="table table-striped"}
@@ -17,7 +17,7 @@ title: Call
17
17
  | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
18
18
  | **recording_id** | **String** | A globally unique identifier for the recording associated with this call. | [optional] |
19
19
  | **segments** | [**Array&lt;Segment&gt;**](Segment.html) | The time line of the participant&#39;s call, divided into activity segments. | [optional] |
20
- | **error_info** | [**ErrorBody**](ErrorBody.html) | | [optional] |
20
+ | **error_info** | [**ErrorInfo**](ErrorInfo.html) | | [optional] |
21
21
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
22
22
  | **start_hold_time** | **DateTime** | The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **document_id** | **String** | If call is an outbound fax of a document from content management, then this is the id in content management. | [optional] |
@@ -17,7 +17,7 @@ title: CallBasic
17
17
  | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
18
18
  | **recording_id** | **String** | A globally unique identifier for the recording associated with this call. | [optional] |
19
19
  | **segments** | [**Array&lt;Segment&gt;**](Segment.html) | The time line of the participant&#39;s call, divided into activity segments. | [optional] |
20
- | **error_info** | [**ErrorBody**](ErrorBody.html) | | [optional] |
20
+ | **error_info** | [**ErrorInfo**](ErrorInfo.html) | | [optional] |
21
21
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
22
22
  | **start_hold_time** | **DateTime** | The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **document_id** | **String** | If call is an outbound fax of a document from content management, then this is the id in content management. | [optional] |
@@ -24,7 +24,7 @@ title: CallMediaParticipant
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] |
@@ -24,7 +24,7 @@ title: CallbackMediaParticipant
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] |
@@ -24,7 +24,7 @@ title: ChatMediaParticipant
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] |
@@ -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&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] |
@@ -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)
@@ -8156,7 +8226,7 @@ Name | Type | Description | Notes
8156
8226
 
8157
8227
  Get messages in batch
8158
8228
 
8159
-
8229
+ The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]
8160
8230
 
8161
8231
  Wraps POST /api/v2/conversations/messages/{conversationId}/messages/bulk
8162
8232
 
@@ -8182,7 +8252,7 @@ end
8182
8252
 
8183
8253
  api_instance = PureCloud::ConversationsApi.new
8184
8254
 
8185
- conversation_id = "conversation_id_example" # String | conversationId
8255
+ conversation_id = "conversation_id_example" # String |
8186
8256
 
8187
8257
  opts = {
8188
8258
  body: [PureCloud::Array<String>.new] # Array<String> | messageIds
@@ -8201,7 +8271,7 @@ end
8201
8271
 
8202
8272
  Name | Type | Description | Notes
8203
8273
  ------------- | ------------- | ------------- | -------------
8204
- **conversation_id** | **String**| conversationId | |
8274
+ **conversation_id** | **String**| | |
8205
8275
  **body** | **Array&lt;String&gt;**| messageIds | [optional] |
8206
8276
  {: class="table table-striped"}
8207
8277
 
@@ -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,14 @@
1
+ ---
2
+ title: EdgeNetworkDiagnostic
3
+ ---
4
+ ## PureCloud::EdgeNetworkDiagnostic
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **self_uri** | **String** | The URI for this object | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: EdgeNetworkDiagnosticRequest
3
+ ---
4
+ ## PureCloud::EdgeNetworkDiagnosticRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **host** | **String** | IPv4/6 address or host to be probed for connectivity. No port allowed. | |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: EdgeNetworkDiagnosticResponse
3
+ ---
4
+ ## PureCloud::EdgeNetworkDiagnosticResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **command_correlation_id** | **String** | UUID of each executed command on edge | [optional] |
11
+ | **diagnostics** | **String** | Response string of executed command from edge | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+