purecloudplatformclientv2 85.0.1 → 86.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 (244) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/Call.md +1 -0
  5. data/docs/CallBasic.md +1 -0
  6. data/docs/Callback.md +1 -0
  7. data/docs/CallbackBasic.md +1 -0
  8. data/docs/Cobrowsesession.md +1 -0
  9. data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
  10. data/docs/ContextIntent.md +13 -0
  11. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  12. data/docs/ConversationChat.md +1 -0
  13. data/docs/ConversationEventTopicCallback.md +1 -0
  14. data/docs/Coretype.md +23 -0
  15. data/docs/CoretypeListing.md +15 -0
  16. data/docs/DataExtensionsApi.md +198 -0
  17. data/docs/DataSchemaListing.md +15 -0
  18. data/docs/DetectedDialogAct.md +14 -0
  19. data/docs/DetectedIntent.md +15 -0
  20. data/docs/DetectedNamedEntity.md +16 -0
  21. data/docs/DetectedNamedEntityValue.md +14 -0
  22. data/docs/DialogflowAgent.md +3 -2
  23. data/docs/Edge.md +1 -1
  24. data/docs/Email.md +1 -0
  25. data/docs/EntityListing.md +1 -5
  26. data/docs/ExternalContactsApi.md +1001 -144
  27. data/docs/FlowDivisionView.md +2 -0
  28. data/docs/IntentDefinition.md +15 -0
  29. data/docs/IntentFeedback.md +16 -0
  30. data/docs/ItemValidationLimits.md +14 -0
  31. data/docs/Items.md +14 -0
  32. data/docs/LanguageUnderstandingApi.md +1160 -0
  33. data/docs/MaxLength.md +14 -0
  34. data/docs/Message.md +1 -0
  35. data/docs/MinLength.md +14 -0
  36. data/docs/NamedEntityAnnotation.md +13 -0
  37. data/docs/NamedEntityTypeBinding.md +14 -0
  38. data/docs/NamedEntityTypeDefinition.md +15 -0
  39. data/docs/NamedEntityTypeItem.md +14 -0
  40. data/docs/NamedEntityTypeMechanism.md +15 -0
  41. data/docs/NluConfusionMatrixColumn.md +14 -0
  42. data/docs/NluConfusionMatrixRow.md +14 -0
  43. data/docs/NluDetectionContext.md +14 -0
  44. data/docs/NluDetectionInput.md +13 -0
  45. data/docs/NluDetectionOutput.md +14 -0
  46. data/docs/NluDetectionRequest.md +14 -0
  47. data/docs/NluDetectionResponse.md +15 -0
  48. data/docs/NluDomain.md +19 -0
  49. data/docs/NluDomainListing.md +22 -0
  50. data/docs/NluDomainVersion.md +24 -0
  51. data/docs/NluDomainVersionListing.md +22 -0
  52. data/docs/NluDomainVersionQualityReport.md +15 -0
  53. data/docs/NluDomainVersionTrainingResponse.md +14 -0
  54. data/docs/NluFeedbackListing.md +22 -0
  55. data/docs/NluFeedbackRequest.md +15 -0
  56. data/docs/NluFeedbackResponse.md +18 -0
  57. data/docs/NluQualityReportSummary.md +13 -0
  58. data/docs/NluQualityReportSummaryMetric.md +14 -0
  59. data/docs/NluUtterance.md +13 -0
  60. data/docs/NluUtteranceSegment.md +14 -0
  61. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  62. data/docs/QueueConversationEventTopicCallback.md +1 -0
  63. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  64. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  65. data/docs/ReportingExportJobRequest.md +1 -0
  66. data/docs/ReportingExportJobResponse.md +2 -0
  67. data/docs/RoutingApi.md +65 -0
  68. data/docs/SCIMApi.md +12 -12
  69. data/docs/Schema.md +17 -0
  70. data/docs/SchemaQuantityLimits.md +26 -0
  71. data/docs/ScimV2EnterpriseUser.md +1 -0
  72. data/docs/Screenshare.md +1 -0
  73. data/docs/SocialExpression.md +1 -0
  74. data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
  75. data/docs/TimeOffRequestListing.md +13 -0
  76. data/docs/UploadUrlRequest.md +15 -0
  77. data/docs/UploadUrlResponse.md +14 -0
  78. data/docs/UploadsApi.md +78 -0
  79. data/docs/ValidationLimits.md +18 -0
  80. data/docs/Video.md +1 -0
  81. data/docs/WorkforceManagementApi.md +297 -448
  82. data/lib/purecloudplatformclientv2.rb +50 -57
  83. data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
  84. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
  85. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
  86. data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
  87. data/lib/purecloudplatformclientv2/api/scim_api.rb +8 -8
  88. data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
  89. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
  90. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  91. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  92. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
  93. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  94. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  95. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  96. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  97. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  98. data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → context_entity.rb} +14 -9
  99. data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_intent.rb} +14 -10
  100. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
  101. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  103. data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → coretype.rb} +97 -102
  104. data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → coretype_listing.rb} +34 -11
  105. data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
  106. data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
  107. data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
  108. data/lib/purecloudplatformclientv2/models/detected_named_entity.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
  110. data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
  111. data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
  112. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  113. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  114. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
  115. data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → intent_definition.rb} +30 -19
  116. data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → intent_feedback.rb} +71 -18
  117. data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → item_validation_limits.rb} +18 -45
  118. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → items.rb} +33 -10
  119. data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
  120. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  121. data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
  122. data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → named_entity_annotation.rb} +14 -10
  123. data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
  124. data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
  125. data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
  126. data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
  127. data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
  128. data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
  129. data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
  130. data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → nlu_detection_input.rb} +14 -10
  131. data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
  132. data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
  133. data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
  134. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
  135. data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → nlu_domain_listing.rb} +156 -53
  136. data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → nlu_domain_version.rb} +132 -87
  137. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
  138. data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
  139. data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → nlu_domain_version_training_response.rb} +33 -16
  140. data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → nlu_feedback_listing.rb} +158 -46
  141. data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
  142. data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
  143. data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
  144. data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
  145. data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
  147. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
  148. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  149. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  150. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  151. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
  152. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
  153. data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
  154. data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
  155. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
  156. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  157. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
  158. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  159. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
  160. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
  161. data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → upload_url_request.rb} +23 -26
  162. data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
  163. data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → validation_limits.rb} +76 -38
  164. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  165. data/lib/purecloudplatformclientv2/version.rb +1 -1
  166. metadata +102 -116
  167. data/docs/AsyncWeekScheduleResponse.md +0 -16
  168. data/docs/CopyShortTermForecastRequest.md +0 -14
  169. data/docs/CopyWeekScheduleRequest.md +0 -14
  170. data/docs/CreateQueueMediaAssociationRequest.md +0 -15
  171. data/docs/CreateServiceGoalGroupRequest.md +0 -15
  172. data/docs/ForecastGenerationResult.md +0 -13
  173. data/docs/ForecastGenerationRouteGroupResult.md +0 -14
  174. data/docs/ForecastResultResponse.md +0 -14
  175. data/docs/ForecastTimeSeriesResult.md +0 -14
  176. data/docs/GenerateShortTermForecastRequest.md +0 -13
  177. data/docs/GenerateShortTermForecastResponse.md +0 -16
  178. data/docs/GenerateWeekScheduleRequest.md +0 -14
  179. data/docs/GenerateWeekScheduleResponse.md +0 -15
  180. data/docs/ImportShortTermForecastRequest.md +0 -16
  181. data/docs/ImportWeekScheduleRequest.md +0 -17
  182. data/docs/IntradayDataGroup.md +0 -19
  183. data/docs/IntradayForecastData.md +0 -15
  184. data/docs/IntradayHistoricalAgentData.md +0 -14
  185. data/docs/IntradayHistoricalQueueData.md +0 -20
  186. data/docs/IntradayMetric.md +0 -14
  187. data/docs/IntradayPerformancePredictionAgentData.md +0 -13
  188. data/docs/IntradayPerformancePredictionQueueData.md +0 -15
  189. data/docs/IntradayQueryDataCommand.md +0 -17
  190. data/docs/IntradayQueue.md +0 -15
  191. data/docs/IntradayResponse.md +0 -20
  192. data/docs/IntradayScheduleData.md +0 -14
  193. data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
  194. data/docs/ListWrapperWfmForecastModification.md +0 -13
  195. data/docs/QueueMediaAssociation.md +0 -16
  196. data/docs/RescheduleRequest.md +0 -20
  197. data/docs/RescheduleResult.md +0 -13
  198. data/docs/ReschedulingOptionsResponse.md +0 -22
  199. data/docs/RouteGroup.md +0 -18
  200. data/docs/RouteGroupAttributes.md +0 -16
  201. data/docs/RouteGroupList.md +0 -14
  202. data/docs/SchedulingRunListResponse.md +0 -13
  203. data/docs/SchedulingRunResponse.md +0 -28
  204. data/docs/ServiceGoalGroup.md +0 -18
  205. data/docs/ServiceGoalGroupGoals.md +0 -15
  206. data/docs/ServiceGoalGroupList.md +0 -14
  207. data/docs/ShortTermForecast.md +0 -22
  208. data/docs/ShortTermForecastListItemResponse.md +0 -18
  209. data/docs/ShortTermForecastListResponse.md +0 -13
  210. data/docs/ShortTermForecastResponse.md +0 -15
  211. data/docs/TimeOffRequestEntityList.md +0 -13
  212. data/docs/TimeOffRequestLookupList.md +0 -13
  213. data/docs/UnscheduledAgentWarning.md +0 -14
  214. data/docs/UpdateWeekScheduleRequest.md +0 -21
  215. data/docs/UserSchedulesPartialUploadRequest.md +0 -13
  216. data/docs/WfmAbandonRate.md +0 -14
  217. data/docs/WfmAverageSpeedOfAnswer.md +0 -14
  218. data/docs/WfmForecastModification.md +0 -20
  219. data/docs/WfmForecastModificationAttributes.md +0 -16
  220. data/docs/WfmIntradayQueueListing.md +0 -14
  221. data/docs/WfmServiceLevel.md +0 -15
  222. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
  223. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
  224. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
  225. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +0 -294
  226. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
  227. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
  228. data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
  229. data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
  230. data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +0 -384
  231. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +0 -202
  232. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
  233. data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
  234. data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
  235. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +0 -283
  236. data/lib/purecloudplatformclientv2/models/reschedule_request.rb +0 -418
  237. data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
  238. data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
  239. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +0 -307
  240. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
  241. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +0 -203
  242. data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +0 -242
  243. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +0 -438
  244. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
data/docs/NluUtterance.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: NluUtterance
3
+ ---
4
+ ## PureCloud::NluUtterance
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **segments** | [**Array<NluUtteranceSegment>**](NluUtteranceSegment.html) | The list of segments that that constitute this utterance for the given intent. | |
11
+ {: class="table table-striped"}
12
+
13
+
data/docs/NluUtteranceSegment.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: NluUtteranceSegment
3
+ ---
4
+ ## PureCloud::NluUtteranceSegment
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **text** | **String** | The text of the segment. | |
11
+ | **entity** | [**NamedEntityAnnotation**](NamedEntityAnnotation.html) | The entity annotation of the segment. | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md CHANGED
@@ -46,6 +46,7 @@ title: QueueConversationCallbackEventTopicCallbackMediaParticipant
46
46
  | **callback_numbers** | **Array<String>** | | [optional] |
47
47
  | **callback_user_name** | **String** | | [optional] |
48
48
  | **skip_enabled** | **BOOLEAN** | | [optional] |
49
+ | **external_campaign** | **BOOLEAN** | | [optional] |
49
50
  | **timeout_seconds** | **Integer** | | [optional] |
50
51
  | **callback_scheduled_time** | **DateTime** | | [optional] |
51
52
  | **automated_callback_config_id** | **String** | | [optional] |
data/docs/QueueConversationEventTopicCallback.md CHANGED
@@ -19,6 +19,7 @@ title: QueueConversationEventTopicCallback
19
19
  | **callback_user_name** | **String** | | [optional] |
20
20
  | **script_id** | **String** | | [optional] |
21
21
  | **peer_id** | **String** | | [optional] |
22
+ | **external_campaign** | **BOOLEAN** | | [optional] |
22
23
  | **skip_enabled** | **BOOLEAN** | | [optional] |
23
24
  | **provider** | **String** | | [optional] |
24
25
  | **timeout_seconds** | **Integer** | | [optional] |
data/docs/QueueConversationSocialExpressionEventTopicCallback.md CHANGED
@@ -19,6 +19,7 @@ title: QueueConversationSocialExpressionEventTopicCallback
19
19
  | **callback_user_name** | **String** | | [optional] |
20
20
  | **script_id** | **String** | | [optional] |
21
21
  | **peer_id** | **String** | | [optional] |
22
+ | **external_campaign** | **BOOLEAN** | | [optional] |
22
23
  | **skip_enabled** | **BOOLEAN** | | [optional] |
23
24
  | **provider** | **String** | | [optional] |
24
25
  | **timeout_seconds** | **Integer** | | [optional] |
data/docs/QueueConversationVideoEventTopicCallback.md CHANGED
@@ -19,6 +19,7 @@ title: QueueConversationVideoEventTopicCallback
19
19
  | **callback_user_name** | **String** | | [optional] |
20
20
  | **script_id** | **String** | | [optional] |
21
21
  | **peer_id** | **String** | | [optional] |
22
+ | **external_campaign** | **BOOLEAN** | | [optional] |
22
23
  | **skip_enabled** | **BOOLEAN** | | [optional] |
23
24
  | **provider** | **String** | | [optional] |
24
25
  | **timeout_seconds** | **Integer** | | [optional] |
data/docs/ReportingExportJobRequest.md CHANGED
@@ -20,6 +20,7 @@ title: ReportingExportJobRequest
20
20
  | **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
21
21
  | **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
22
22
  | **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
23
+ | **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
23
24
  {: class="table table-striped"}
24
25
 
25
26
 
data/docs/ReportingExportJobResponse.md CHANGED
@@ -27,6 +27,8 @@ title: ReportingExportJobResponse
27
27
  | **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
28
28
  | **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
29
29
  | **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
30
+ | **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
31
+ | **email_statuses** | **Hash<String, String>** | The status of individual email addresses as a map | [optional] |
30
32
  | **self_uri** | **String** | The URI for this object | [optional] |
31
33
  {: class="table table-striped"}
32
34
 
data/docs/RoutingApi.md CHANGED
@@ -15,6 +15,7 @@ Method | Description
15
15
  [**delete_routing_queue_wrapupcode**](RoutingApi.html#delete_routing_queue_wrapupcode) | Delete a wrap-up code from a queue
16
16
  [**delete_routing_settings**](RoutingApi.html#delete_routing_settings) | Delete an organization's routing settings
17
17
  [**delete_routing_skill**](RoutingApi.html#delete_routing_skill) | Delete Routing Skill
18
+ [**delete_routing_sms_address**](RoutingApi.html#delete_routing_sms_address) | Delete an Address by Id for SMS
18
19
  [**delete_routing_sms_phonenumber**](RoutingApi.html#delete_routing_sms_phonenumber) | Delete a phone number provisioned for SMS.
19
20
  [**delete_routing_user_utilization**](RoutingApi.html#delete_routing_user_utilization) | Delete the user's max utilization settings and revert to the organization-wide default.
20
21
  [**delete_routing_utilization**](RoutingApi.html#delete_routing_utilization) | Delete the organization-wide max utilization settings and revert to the system default.
@@ -546,6 +547,70 @@ nil (empty response body)
546
547
 
547
548
 
548
549
 
550
+ <a name="delete_routing_sms_address"></a>
551
+
552
+ ## delete_routing_sms_address(address_id)
553
+
554
+
555
+
556
+ Delete an Address by Id for SMS
557
+
558
+
559
+
560
+ Wraps DELETE /api/v2/routing/sms/addresses/{addressId}
561
+
562
+ Requires ALL permissions:
563
+
564
+ * sms:phoneNumber:delete
565
+
566
+
567
+ ### Example
568
+ ```{"language":"ruby"}
569
+ # load the gem
570
+ require 'purecloudplatformclientv2'
571
+ # setup authorization
572
+ @secret = ENV['PURECLOUD_SECRET']
573
+ @id = ENV['PURECLOUD_CLIENT_ID']
574
+ environment = "mypurecloud.com"
575
+
576
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
577
+
578
+ PureCloud.configure do |config|
579
+ config.access_token = @authToken
580
+ end
581
+
582
+ api_instance = PureCloud::RoutingApi.new
583
+
584
+ address_id = "address_id_example" # String | Address ID
585
+
586
+
587
+ begin
588
+ #Delete an Address by Id for SMS
589
+ api_instance.delete_routing_sms_address(address_id)
590
+ rescue PureCloud::ApiError => e
591
+ puts "Exception when calling RoutingApi->delete_routing_sms_address: #{e}"
592
+ end
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ Name | Type | Description | Notes
598
+ ------------- | ------------- | ------------- | -------------
599
+ **address_id** | **String**| Address ID | |
600
+ {: class="table table-striped"}
601
+
602
+
603
+ ### Return type
604
+
605
+ nil (empty response body)
606
+
607
+ ### HTTP request headers
608
+
609
+ - **Content-Type**: application/json
610
+ - **Accept**: application/json
611
+
612
+
613
+
549
614
  <a name="delete_routing_sms_phonenumber"></a>
550
615
 
551
616
  ## delete_routing_sms_phonenumber(address_id)
data/docs/SCIMApi.md CHANGED
@@ -820,7 +820,7 @@ api_instance = PureCloud::SCIMApi.new
820
820
  user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
821
821
 
822
822
  opts = {
823
- attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
823
+ attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
824
824
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
825
825
  if_none_match: "if_none_match_example" # String | TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
826
826
  }
@@ -839,8 +839,8 @@ end
839
839
  Name | Type | Description | Notes
840
840
  ------------- | ------------- | ------------- | -------------
841
841
  **user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
842
- **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
843
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
842
+ **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
843
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
844
844
  **if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
845
845
  {: class="table table-striped"}
846
846
 
@@ -895,7 +895,7 @@ api_instance = PureCloud::SCIMApi.new
895
895
  opts = {
896
896
  start_index: 1, # Integer | The 1-based index of the first query result.
897
897
  count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
898
- attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
898
+ attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
899
899
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
900
900
  filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
901
901
  }
@@ -915,8 +915,8 @@ Name | Type | Description | Notes
915
915
  ------------- | ------------- | ------------- | -------------
916
916
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
917
917
  **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. | [optional] [default to 25] |
918
- **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
919
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
918
+ **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
919
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
920
920
  **filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;. | [optional] |
921
921
  {: class="table table-striped"}
922
922
 
@@ -1435,7 +1435,7 @@ api_instance = PureCloud::SCIMApi.new
1435
1435
  user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
1436
1436
 
1437
1437
  opts = {
1438
- attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1438
+ attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1439
1439
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
1440
1440
  if_none_match: "if_none_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
1441
1441
  }
@@ -1454,8 +1454,8 @@ end
1454
1454
  Name | Type | Description | Notes
1455
1455
  ------------- | ------------- | ------------- | -------------
1456
1456
  **user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
1457
- **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1458
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1457
+ **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1458
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1459
1459
  **if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
1460
1460
  {: class="table table-striped"}
1461
1461
 
@@ -1510,7 +1510,7 @@ api_instance = PureCloud::SCIMApi.new
1510
1510
  opts = {
1511
1511
  start_index: 1, # Integer | The 1-based index of the first query result.
1512
1512
  count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
1513
- attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1513
+ attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
1514
1514
  excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
1515
1515
  filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
1516
1516
  }
@@ -1530,8 +1530,8 @@ Name | Type | Description | Notes
1530
1530
  ------------- | ------------- | ------------- | -------------
1531
1531
  **start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
1532
1532
  **count** | **Integer**| The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. | [optional] [default to 25] |
1533
- **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1534
- **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1533
+ **attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1534
+ **excluded_attributes** | [**Array&lt;String&gt;**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
1535
1535
  **filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;. | [optional] |
1536
1536
  {: class="table table-striped"}
1537
1537
 
data/docs/Schema.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: Schema
3
+ ---
4
+ ## PureCloud::Schema
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **title** | **String** | A core type&#39;s title | [optional] |
11
+ | **description** | **String** | A core type&#39;s description | [optional] |
12
+ | **type** | **Array&lt;String&gt;** | An array of fundamental JSON Schema primitive types on which the core type is based | [optional] |
13
+ | **items** | [**Items**](Items.html) | Denotes the type and pattern of the items in an enum core type | [optional] |
14
+ | **pattern** | **String** | For the \&quot;date\&quot; and \&quot;datetime\&quot; core types, denotes the regex prescribing the allowable date/datetime format | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
data/docs/SchemaQuantityLimits.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: SchemaQuantityLimits
3
+ ---
4
+ ## PureCloud::SchemaQuantityLimits
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
+ | **min_field_name_characters** | **Integer** | The minimum number of schema field name characters allowed. | [optional] |
13
+ | **max_field_name_characters** | **Integer** | The maximum number of schema field name characters allowed. | [optional] |
14
+ | **min_field_description_characters** | **Integer** | The minimum number of schema field description characters allowed. | [optional] |
15
+ | **max_field_description_characters** | **Integer** | The maximum number of schema field description characters allowed. | [optional] |
16
+ | **min_schema_name_characters** | **Integer** | The minimum number of schema name characters allowed. | [optional] |
17
+ | **max_schema_name_characters** | **Integer** | The maximum number of schema name characters allowed. | [optional] |
18
+ | **min_schema_description_characters** | **Integer** | The minimum number of schema description characters allowed. | [optional] |
19
+ | **max_schema_description_characters** | **Integer** | The maximum number of schema description characters allowed. | [optional] |
20
+ | **max_number_of_schemas_per_org** | **Integer** | The maximum number of schema allowed per org. | [optional] |
21
+ | **max_number_of_fields_per_schema** | **Integer** | The maximum number of schema fields allowed per schema. | [optional] |
22
+ | **max_number_of_fields_per_org** | **Integer** | The maximum number of schema fields allowed per organization across all of their schemas. | [optional] |
23
+ | **self_uri** | **String** | The URI for this object | [optional] |
24
+ {: class="table table-striped"}
25
+
26
+
data/docs/ScimV2EnterpriseUser.md CHANGED
@@ -10,6 +10,7 @@ title: ScimV2EnterpriseUser
10
10
  | **division** | **String** | The division that the user belongs to. | [optional] |
11
11
  | **department** | **String** | The department that the user belongs to. | [optional] |
12
12
  | **manager** | [**Manager**](Manager.html) | The user&#39;s manager. | [optional] |
13
+ | **employee_number** | **String** | The users employee number. | [optional] |
13
14
  {: class="table table-striped"}
14
15
 
15
16
 
data/docs/Screenshare.md CHANGED
@@ -19,6 +19,7 @@ title: Screenshare
19
19
  | **provider** | **String** | The source provider for the screen share. | [optional] |
20
20
  | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
21
21
  | **segments** | [**Array&lt;Segment&gt;**](Segment.html) | The time line of the participant&#39;s call, divided into activity segments. | [optional] |
22
+ | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
22
23
  {: class="table table-striped"}
23
24
 
24
25
 
data/docs/SocialExpression.md CHANGED
@@ -24,6 +24,7 @@ title: SocialExpression
24
24
  | **provider** | **String** | The source provider for the social expression. | [optional] |
25
25
  | **script_id** | **String** | The UUID of the script to use. | [optional] |
26
26
  | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
27
+ | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
27
28
  {: class="table table-striped"}
28
29
 
29
30
 
data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} RENAMED
@@ -1,7 +1,7 @@
1
1
  ---
2
- title: TimeOffRequestLookup
2
+ title: TimeOffRequest
3
3
  ---
4
- ## PureCloud::TimeOffRequestLookup
4
+ ## PureCloud::TimeOffRequest
5
5
 
6
6
  ## Properties
7
7
 
data/docs/TimeOffRequestListing.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: TimeOffRequestListing
3
+ ---
4
+ ## PureCloud::TimeOffRequestListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;TimeOffRequest&gt;**](TimeOffRequest.html) | List of time off request look up objects | |
11
+ {: class="table table-striped"}
12
+
13
+
data/docs/UploadUrlRequest.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: UploadUrlRequest
3
+ ---
4
+ ## PureCloud::UploadUrlRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **file_name** | **String** | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\&quot;&gt;[~&lt;#| | [optional] |
11
+ | **content_md5** | **String** | Content MD-5 of the file to upload | [optional] |
12
+ | **signed_url_timeout_seconds** | **Integer** | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
data/docs/UploadUrlResponse.md ADDED
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: UploadUrlResponse
3
+ ---
4
+ ## PureCloud::UploadUrlResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **url** | **String** | Presigned url to PUT the file to | [optional] |
11
+ | **headers** | **Hash&lt;String, String&gt;** | Required headers when uploading a file through PUT request to the URL | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
data/docs/UploadsApi.md ADDED
@@ -0,0 +1,78 @@
1
+ ---
2
+ title: UploadsApi
3
+ ---
4
+
5
+ ## PureCloud::UploadsApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**post_uploads_publicassets_images**](UploadsApi.html#post_uploads_publicassets_images) | Creates presigned url for uploading a public asset image
12
+ {: class="table table-striped"}
13
+
14
+ <a name="post_uploads_publicassets_images"></a>
15
+
16
+ ## [**UploadUrlResponse**](UploadUrlResponse.html) post_uploads_publicassets_images(body)
17
+
18
+
19
+
20
+ Creates presigned url for uploading a public asset image
21
+
22
+
23
+
24
+ Wraps POST /api/v2/uploads/publicassets/images
25
+
26
+ Requires ALL permissions:
27
+
28
+ * uploads:publicasset:upload
29
+
30
+
31
+ ### Example
32
+ ```{"language":"ruby"}
33
+ # load the gem
34
+ require 'purecloudplatformclientv2'
35
+ # setup authorization
36
+ @secret = ENV['PURECLOUD_SECRET']
37
+ @id = ENV['PURECLOUD_CLIENT_ID']
38
+ environment = "mypurecloud.com"
39
+
40
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
41
+
42
+ PureCloud.configure do |config|
43
+ config.access_token = @authToken
44
+ end
45
+
46
+ api_instance = PureCloud::UploadsApi.new
47
+
48
+ body = PureCloud::UploadUrlRequest.new # UploadUrlRequest | query
49
+
50
+
51
+ begin
52
+ #Creates presigned url for uploading a public asset image
53
+ result = api_instance.post_uploads_publicassets_images(body)
54
+ p result
55
+ rescue PureCloud::ApiError => e
56
+ puts "Exception when calling UploadsApi->post_uploads_publicassets_images: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ Name | Type | Description | Notes
63
+ ------------- | ------------- | ------------- | -------------
64
+ **body** | [**UploadUrlRequest**](UploadUrlRequest.html)| query | |
65
+ {: class="table table-striped"}
66
+
67
+
68
+ ### Return type
69
+
70
+ [**UploadUrlResponse**](UploadUrlResponse.html)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
78
+