purecloudplatformclientv2 2.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1825) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +56 -0
  3. data/docs/ADFS.md +20 -0
  4. data/docs/Actions.md +13 -0
  5. data/docs/ActivityCode.md +20 -0
  6. data/docs/ActivityCodeContainer.md +13 -0
  7. data/docs/AcwSettings.md +14 -0
  8. data/docs/Address.md +17 -0
  9. data/docs/AddressableEntityUser.md +14 -0
  10. data/docs/AddressableLicenseDefinition.md +14 -0
  11. data/docs/Adjacents.md +15 -0
  12. data/docs/Agent.md +13 -0
  13. data/docs/AgentActivity.md +19 -0
  14. data/docs/AgentActivityEntityListing.md +22 -0
  15. data/docs/AgentEvaluatorActivity.md +19 -0
  16. data/docs/AggregateDataContainer.md +14 -0
  17. data/docs/AggregateMetricData.md +15 -0
  18. data/docs/AggregateQueryResponse.md +13 -0
  19. data/docs/AggregateViewData.md +14 -0
  20. data/docs/AggregationQuery.md +20 -0
  21. data/docs/AggregationRange.md +14 -0
  22. data/docs/AggregationResult.md +17 -0
  23. data/docs/AggregationResultEntry.md +16 -0
  24. data/docs/AlertingApi.md +2129 -0
  25. data/docs/AnalyticsApi.md +1347 -0
  26. data/docs/AnalyticsConversation.md +17 -0
  27. data/docs/AnalyticsConversationQueryResponse.md +14 -0
  28. data/docs/AnalyticsConversationSegment.md +36 -0
  29. data/docs/AnalyticsEvaluation.md +22 -0
  30. data/docs/AnalyticsParticipant.md +19 -0
  31. data/docs/AnalyticsProperty.md +15 -0
  32. data/docs/AnalyticsQueryAggregation.md +17 -0
  33. data/docs/AnalyticsQueryClause.md +14 -0
  34. data/docs/AnalyticsQueryFilter.md +15 -0
  35. data/docs/AnalyticsQueryPredicate.md +20 -0
  36. data/docs/AnalyticsRoutingStatusRecord.md +16 -0
  37. data/docs/AnalyticsSession.md +44 -0
  38. data/docs/AnalyticsUserDetail.md +15 -0
  39. data/docs/AnalyticsUserDetailsQueryResponse.md +14 -0
  40. data/docs/AnalyticsUserPresenceRecord.md +17 -0
  41. data/docs/AnalyticsView.md +16 -0
  42. data/docs/Annotation.md +30 -0
  43. data/docs/AnswerOption.md +15 -0
  44. data/docs/ArchitectApi.md +2924 -0
  45. data/docs/ArchiveRetention.md +14 -0
  46. data/docs/Attachment.md +17 -0
  47. data/docs/AttemptLimits.md +22 -0
  48. data/docs/AttemptLimitsEntityListing.md +22 -0
  49. data/docs/AttemptLimitsNotification.md +24 -0
  50. data/docs/AttemptLimitsNotificationRecallEntries.md +15 -0
  51. data/docs/AttemptLimitsNotificationRecallEntry.md +15 -0
  52. data/docs/Attribute.md +21 -0
  53. data/docs/AttributeEntityListing.md +22 -0
  54. data/docs/AttributeFilterItem.md +15 -0
  55. data/docs/AttributeQueryRequest.md +15 -0
  56. data/docs/AttributesApi.md +377 -0
  57. data/docs/AuditChange.md +16 -0
  58. data/docs/AuditEntity.md +16 -0
  59. data/docs/AuditEntityReference.md +17 -0
  60. data/docs/AuditFacet.md +14 -0
  61. data/docs/AuditFilter.md +16 -0
  62. data/docs/AuditMessage.md +28 -0
  63. data/docs/AuditSearchResult.md +18 -0
  64. data/docs/AuditUser.md +15 -0
  65. data/docs/AuthorizationApi.md +1067 -0
  66. data/docs/AvailableLanguageList.md +13 -0
  67. data/docs/AvailableTopic.md +16 -0
  68. data/docs/AvailableTopicEntityListing.md +13 -0
  69. data/docs/AvailableTranslations.md +14 -0
  70. data/docs/Bullseye.md +13 -0
  71. data/docs/Calibration.md +28 -0
  72. data/docs/CalibrationAssignment.md +16 -0
  73. data/docs/CalibrationCreate.md +28 -0
  74. data/docs/CalibrationEntityListing.md +22 -0
  75. data/docs/Call.md +31 -0
  76. data/docs/CallBasic.md +31 -0
  77. data/docs/CallCommand.md +13 -0
  78. data/docs/CallConversation.md +18 -0
  79. data/docs/CallConversationEntityListing.md +22 -0
  80. data/docs/CallConversationNotification.md +17 -0
  81. data/docs/CallConversationNotificationCallMediaParticipant.md +48 -0
  82. data/docs/CallConversationNotificationDetail.md +16 -0
  83. data/docs/CallConversationNotificationErrorBody.md +22 -0
  84. data/docs/CallConversationNotificationErrorInfo.md +22 -0
  85. data/docs/CallConversationNotificationFaxStatus.md +20 -0
  86. data/docs/CallConversationNotificationParticipants.md +48 -0
  87. data/docs/CallConversationNotificationUriReference.md +14 -0
  88. data/docs/CallConversationNotificationWrapup.md +18 -0
  89. data/docs/CallForwarding.md +19 -0
  90. data/docs/CallMediaParticipant.md +48 -0
  91. data/docs/CallMediaPolicy.md +14 -0
  92. data/docs/CallMediaPolicyConditions.md +19 -0
  93. data/docs/CallRecord.md +14 -0
  94. data/docs/CallableContactsDiagnostic.md +16 -0
  95. data/docs/CallableTime.md +14 -0
  96. data/docs/CallableTimeSet.md +19 -0
  97. data/docs/CallableTimeSetEntityListing.md +22 -0
  98. data/docs/CallableTimeSetNotification.md +19 -0
  99. data/docs/CallableTimeSetNotificationCallableTime.md +15 -0
  100. data/docs/CallableTimeSetNotificationCallableTimes.md +15 -0
  101. data/docs/CallableTimeSetNotificationTimeSlot.md +16 -0
  102. data/docs/CallableTimeSetNotificationTimeSlots.md +16 -0
  103. data/docs/Callback.md +30 -0
  104. data/docs/CallbackBasic.md +30 -0
  105. data/docs/CallbackConversation.md +17 -0
  106. data/docs/CallbackConversationEntityListing.md +22 -0
  107. data/docs/CallbackConversationNotification.md +16 -0
  108. data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +44 -0
  109. data/docs/CallbackConversationNotificationDetail.md +16 -0
  110. data/docs/CallbackConversationNotificationDialerPreview.md +18 -0
  111. data/docs/CallbackConversationNotificationErrorBody.md +22 -0
  112. data/docs/CallbackConversationNotificationErrorInfo.md +22 -0
  113. data/docs/CallbackConversationNotificationErrorInfoDetails.md +16 -0
  114. data/docs/CallbackConversationNotificationParticipants.md +44 -0
  115. data/docs/CallbackConversationNotificationPhoneNumberColumn.md +15 -0
  116. data/docs/CallbackConversationNotificationUriReference.md +14 -0
  117. data/docs/CallbackConversationNotificationWrapup.md +18 -0
  118. data/docs/CallbackIdentifier.md +14 -0
  119. data/docs/CallbackMediaParticipant.md +44 -0
  120. data/docs/Campaign.md +41 -0
  121. data/docs/CampaignDiagnostics.md +16 -0
  122. data/docs/CampaignEntityListing.md +22 -0
  123. data/docs/CampaignInteraction.md +33 -0
  124. data/docs/CampaignInteractions.md +18 -0
  125. data/docs/CampaignNotification.md +43 -0
  126. data/docs/CampaignNotificationContactSort.md +16 -0
  127. data/docs/CampaignNotificationErrors.md +15 -0
  128. data/docs/CampaignNotificationPhoneColumn.md +15 -0
  129. data/docs/CampaignNotificationPhoneColumns.md +15 -0
  130. data/docs/CampaignNotificationRestErrorDetail.md +15 -0
  131. data/docs/CampaignNotificationUriReference.md +14 -0
  132. data/docs/CampaignProgress.md +17 -0
  133. data/docs/CampaignProgressNotification.md +17 -0
  134. data/docs/CampaignProgressNotificationUriReference.md +14 -0
  135. data/docs/CampaignRule.md +23 -0
  136. data/docs/CampaignRuleAction.md +16 -0
  137. data/docs/CampaignRuleActionEntities.md +15 -0
  138. data/docs/CampaignRuleCondition.md +15 -0
  139. data/docs/CampaignRuleEntities.md +14 -0
  140. data/docs/CampaignRuleEntityListing.md +22 -0
  141. data/docs/CampaignRuleNotification.md +23 -0
  142. data/docs/CampaignRuleNotificationCampaignRuleAction.md +17 -0
  143. data/docs/CampaignRuleNotificationCampaignRuleActionEntities.md +16 -0
  144. data/docs/CampaignRuleNotificationCampaignRuleActions.md +17 -0
  145. data/docs/CampaignRuleNotificationCampaignRuleCondition.md +16 -0
  146. data/docs/CampaignRuleNotificationCampaignRuleConditions.md +16 -0
  147. data/docs/CampaignRuleNotificationCampaignRuleEntities.md +14 -0
  148. data/docs/CampaignRuleNotificationUriReference.md +14 -0
  149. data/docs/CampaignRuleParameters.md +16 -0
  150. data/docs/CampaignSchedule.md +21 -0
  151. data/docs/CampaignScheduleNotification.md +21 -0
  152. data/docs/CampaignScheduleNotificationIntervals.md +15 -0
  153. data/docs/CampaignScheduleNotificationScheduleInterval.md +15 -0
  154. data/docs/CampaignScheduleNotificationUriReference.md +14 -0
  155. data/docs/CampaignSequence.md +23 -0
  156. data/docs/CampaignSequenceEntityListing.md +22 -0
  157. data/docs/CampaignSequenceNotification.md +23 -0
  158. data/docs/CampaignSequenceNotificationUriReference.md +14 -0
  159. data/docs/CampaignStats.md +18 -0
  160. data/docs/CampaignTimeSlot.md +15 -0
  161. data/docs/Certificate.md +13 -0
  162. data/docs/CertificateAuthorityEntityListing.md +22 -0
  163. data/docs/CertificateDetails.md +19 -0
  164. data/docs/Change.md +16 -0
  165. data/docs/Channel.md +14 -0
  166. data/docs/ChannelEntityListing.md +13 -0
  167. data/docs/ChannelTopic.md +14 -0
  168. data/docs/ChannelTopicEntityListing.md +13 -0
  169. data/docs/Chat.md +13 -0
  170. data/docs/ChatConversation.md +17 -0
  171. data/docs/ChatConversationEntityListing.md +22 -0
  172. data/docs/ChatConversationNotification.md +16 -0
  173. data/docs/ChatConversationNotificationChatMediaParticipant.md +38 -0
  174. data/docs/ChatConversationNotificationDetail.md +16 -0
  175. data/docs/ChatConversationNotificationErrorBody.md +22 -0
  176. data/docs/ChatConversationNotificationErrorInfo.md +22 -0
  177. data/docs/ChatConversationNotificationParticipants.md +38 -0
  178. data/docs/ChatConversationNotificationUriReference.md +14 -0
  179. data/docs/ChatConversationNotificationWrapup.md +18 -0
  180. data/docs/ChatMediaParticipant.md +38 -0
  181. data/docs/ChatMediaPolicy.md +14 -0
  182. data/docs/ChatMediaPolicyConditions.md +18 -0
  183. data/docs/ChatMessage.md +21 -0
  184. data/docs/ChatMessageUser.md +17 -0
  185. data/docs/CobrowseConversation.md +17 -0
  186. data/docs/CobrowseConversationEntityListing.md +22 -0
  187. data/docs/CobrowseConversationNotification.md +16 -0
  188. data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +42 -0
  189. data/docs/CobrowseConversationNotificationDetail.md +16 -0
  190. data/docs/CobrowseConversationNotificationErrorBody.md +22 -0
  191. data/docs/CobrowseConversationNotificationErrorInfo.md +22 -0
  192. data/docs/CobrowseConversationNotificationParticipants.md +42 -0
  193. data/docs/CobrowseConversationNotificationUriReference.md +14 -0
  194. data/docs/CobrowseConversationNotificationWrapup.md +18 -0
  195. data/docs/CobrowseMediaParticipant.md +42 -0
  196. data/docs/Cobrowsesession.md +25 -0
  197. data/docs/CommandStatus.md +20 -0
  198. data/docs/CommandStatusEntityListing.md +22 -0
  199. data/docs/Condition.md +19 -0
  200. data/docs/ConnectRate.md +15 -0
  201. data/docs/ConsultTransfer.md +14 -0
  202. data/docs/ConsultTransferResponse.md +13 -0
  203. data/docs/ConsultTransferUpdate.md +13 -0
  204. data/docs/ConsumedResourcesEntityListing.md +22 -0
  205. data/docs/ConsumingResourcesEntityListing.md +22 -0
  206. data/docs/Contact.md +16 -0
  207. data/docs/ContactAddress.md +18 -0
  208. data/docs/ContactCallbackRequest.md +17 -0
  209. data/docs/ContactList.md +25 -0
  210. data/docs/ContactListEntityListing.md +22 -0
  211. data/docs/ContactListNotification.md +25 -0
  212. data/docs/ContactListNotificationContactPhoneNumberColumn.md +16 -0
  213. data/docs/ContactListNotificationImportStatus.md +18 -0
  214. data/docs/ContactListNotificationPhoneColumns.md +16 -0
  215. data/docs/ContactListNotificationUriReference.md +14 -0
  216. data/docs/ContactListing.md +22 -0
  217. data/docs/ContactPhoneNumberColumn.md +15 -0
  218. data/docs/ContactSort.md +15 -0
  219. data/docs/ContentAttributeFilterItem.md +15 -0
  220. data/docs/ContentFacetFilterItem.md +16 -0
  221. data/docs/ContentFilterItem.md +16 -0
  222. data/docs/ContentManagementApi.md +2470 -0
  223. data/docs/ContentQueryRequest.md +20 -0
  224. data/docs/ContentSortItem.md +14 -0
  225. data/docs/Conversation.md +23 -0
  226. data/docs/ConversationAssociation.md +15 -0
  227. data/docs/ConversationBasic.md +18 -0
  228. data/docs/ConversationChat.md +24 -0
  229. data/docs/ConversationEntityListing.md +22 -0
  230. data/docs/ConversationNotification.md +17 -0
  231. data/docs/ConversationNotificationAddress.md +18 -0
  232. data/docs/ConversationNotificationCall.md +32 -0
  233. data/docs/ConversationNotificationCallback.md +30 -0
  234. data/docs/ConversationNotificationCallbacks.md +30 -0
  235. data/docs/ConversationNotificationCalls.md +32 -0
  236. data/docs/ConversationNotificationChat.md +22 -0
  237. data/docs/ConversationNotificationChats.md +22 -0
  238. data/docs/ConversationNotificationCobrowse.md +26 -0
  239. data/docs/ConversationNotificationCobrowsesessions.md +26 -0
  240. data/docs/ConversationNotificationDialerPreview.md +18 -0
  241. data/docs/ConversationNotificationDisconnectReason.md +15 -0
  242. data/docs/ConversationNotificationDisconnectReasons.md +15 -0
  243. data/docs/ConversationNotificationEmail.md +24 -0
  244. data/docs/ConversationNotificationEmails.md +24 -0
  245. data/docs/ConversationNotificationErrorDetails.md +20 -0
  246. data/docs/ConversationNotificationErrorInfo.md +20 -0
  247. data/docs/ConversationNotificationFaxStatus.md +20 -0
  248. data/docs/ConversationNotificationParticipant.md +40 -0
  249. data/docs/ConversationNotificationParticipants.md +40 -0
  250. data/docs/ConversationNotificationPhoneNumberColumn.md +15 -0
  251. data/docs/ConversationNotificationScreenshare.md +22 -0
  252. data/docs/ConversationNotificationScreenshares.md +22 -0
  253. data/docs/ConversationNotificationSelf.md +18 -0
  254. data/docs/ConversationNotificationSocialExpression.md +26 -0
  255. data/docs/ConversationNotificationSocialExpressions.md +26 -0
  256. data/docs/ConversationNotificationVideo.md +24 -0
  257. data/docs/ConversationNotificationVideos.md +24 -0
  258. data/docs/ConversationNotificationWrapup.md +18 -0
  259. data/docs/ConversationQuery.md +20 -0
  260. data/docs/ConversationsApi.md +4864 -0
  261. data/docs/CopyVoicemailMessage.md +15 -0
  262. data/docs/CoverSheet.md +14 -0
  263. data/docs/CreateCallRequest.md +21 -0
  264. data/docs/CreateCallResponse.md +15 -0
  265. data/docs/CreateCallbackCommand.md +20 -0
  266. data/docs/CreateCallbackResponse.md +14 -0
  267. data/docs/CreateEmailRequest.md +24 -0
  268. data/docs/CreateQueueRequest.md +35 -0
  269. data/docs/CreateShareRequest.md +17 -0
  270. data/docs/CreateShareRequestMember.md +14 -0
  271. data/docs/CreateShareResponse.md +23 -0
  272. data/docs/CreateUser.md +18 -0
  273. data/docs/CreateWebChatRequest.md +19 -0
  274. data/docs/CurrentUserScheduleRequestBody.md +14 -0
  275. data/docs/CustomerInteractionCenter.md +19 -0
  276. data/docs/DID.md +28 -0
  277. data/docs/DIDEntityListing.md +22 -0
  278. data/docs/DIDPool.md +28 -0
  279. data/docs/DIDPoolEntityListing.md +22 -0
  280. data/docs/DefaultGreetingList.md +22 -0
  281. data/docs/DeleteRetention.md +13 -0
  282. data/docs/Dependency.md +19 -0
  283. data/docs/DependencyObject.md +21 -0
  284. data/docs/DependencyObjectEntityListing.md +22 -0
  285. data/docs/DependencyStatus.md +21 -0
  286. data/docs/DependencyType.md +16 -0
  287. data/docs/DependencyTypeEntityListing.md +22 -0
  288. data/docs/Destination.md +16 -0
  289. data/docs/Detail.md +16 -0
  290. data/docs/DialerAction.md +16 -0
  291. data/docs/DialerAuditRequest.md +16 -0
  292. data/docs/DialerContact.md +20 -0
  293. data/docs/DialerPreview.md +17 -0
  294. data/docs/DialerRule.md +18 -0
  295. data/docs/DigitLength.md +14 -0
  296. data/docs/DisconnectReason.md +15 -0
  297. data/docs/DncList.md +24 -0
  298. data/docs/DncListCreate.md +24 -0
  299. data/docs/DncListEntityListing.md +22 -0
  300. data/docs/DncListNotification.md +24 -0
  301. data/docs/DncListNotificationImportStatus.md +18 -0
  302. data/docs/Document.md +43 -0
  303. data/docs/DocumentAttribute.md +14 -0
  304. data/docs/DocumentAudit.md +28 -0
  305. data/docs/DocumentAuditEntityListing.md +22 -0
  306. data/docs/DocumentDataV2Notification.md +26 -0
  307. data/docs/DocumentDataV2NotificationCreatedBy.md +14 -0
  308. data/docs/DocumentDataV2NotificationLockData.md +15 -0
  309. data/docs/DocumentDataV2NotificationLockInfo.md +15 -0
  310. data/docs/DocumentDataV2NotificationUserData.md +14 -0
  311. data/docs/DocumentDataV2NotificationWorkspace.md +13 -0
  312. data/docs/DocumentDataV2NotificationWorkspaceData.md +13 -0
  313. data/docs/DocumentEntityListing.md +22 -0
  314. data/docs/DocumentThumbnail.md +16 -0
  315. data/docs/DocumentUpdate.md +21 -0
  316. data/docs/DocumentUpload.md +16 -0
  317. data/docs/DocumentationResult.md +32 -0
  318. data/docs/DocumentationSearchCriteria.md +20 -0
  319. data/docs/DocumentationSearchRequest.md +17 -0
  320. data/docs/DocumentationSearchResponse.md +21 -0
  321. data/docs/DomainCapabilities.md +18 -0
  322. data/docs/DomainCertificateAuthority.md +28 -0
  323. data/docs/DomainEdgeSoftwareUpdateDto.md +22 -0
  324. data/docs/DomainEdgeSoftwareVersionDto.md +20 -0
  325. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +22 -0
  326. data/docs/DomainEntity.md +15 -0
  327. data/docs/DomainEntityListing.md +22 -0
  328. data/docs/DomainEntityListingEvaluationForm.md +22 -0
  329. data/docs/DomainEntityListingQueryResult.md +22 -0
  330. data/docs/DomainLogicalInterface.md +45 -0
  331. data/docs/DomainNetworkAddress.md +16 -0
  332. data/docs/DomainNetworkCommandResponse.md +16 -0
  333. data/docs/DomainNetworkRoute.md +17 -0
  334. data/docs/DomainOrgRoleDifference.md +17 -0
  335. data/docs/DomainOrganizationProduct.md +13 -0
  336. data/docs/DomainOrganizationRole.md +23 -0
  337. data/docs/DomainOrganizationRoleCreate.md +23 -0
  338. data/docs/DomainOrganizationRoleUpdate.md +23 -0
  339. data/docs/DomainPermission.md +17 -0
  340. data/docs/DomainPermissionCollection.md +17 -0
  341. data/docs/DomainPermissionPolicy.md +20 -0
  342. data/docs/DomainPhysicalCapabilities.md +14 -0
  343. data/docs/DomainPhysicalInterface.md +29 -0
  344. data/docs/DomainResourceConditionNode.md +17 -0
  345. data/docs/DomainResourceConditionValue.md +16 -0
  346. data/docs/DomainRole.md +14 -0
  347. data/docs/DomainSchemaReference.md +24 -0
  348. data/docs/DownloadResponse.md +15 -0
  349. data/docs/DurationCondition.md +15 -0
  350. data/docs/Edge.md +50 -0
  351. data/docs/EdgeAutoUpdateConfig.md +16 -0
  352. data/docs/EdgeEntityListing.md +22 -0
  353. data/docs/EdgeGroup.md +27 -0
  354. data/docs/EdgeGroupEntityListing.md +22 -0
  355. data/docs/EdgeInterface.md +20 -0
  356. data/docs/EdgeLine.md +32 -0
  357. data/docs/EdgeLineEntityListing.md +22 -0
  358. data/docs/EdgeLogsJob.md +25 -0
  359. data/docs/EdgeLogsJobFile.md +30 -0
  360. data/docs/EdgeLogsJobRequest.md +15 -0
  361. data/docs/EdgeLogsJobResponse.md +24 -0
  362. data/docs/EdgeLogsJobUploadRequest.md +13 -0
  363. data/docs/EdgeRebootParameters.md +13 -0
  364. data/docs/EdgeServiceStateRequest.md +14 -0
  365. data/docs/EdgeTrunkBase.md +27 -0
  366. data/docs/EdgeVersionInformation.md +13 -0
  367. data/docs/EdgeVersionReport.md +14 -0
  368. data/docs/Email.md +26 -0
  369. data/docs/EmailAddress.md +14 -0
  370. data/docs/EmailAttachment.md +17 -0
  371. data/docs/EmailConversation.md +17 -0
  372. data/docs/EmailConversationEntityListing.md +22 -0
  373. data/docs/EmailConversationNotification.md +16 -0
  374. data/docs/EmailConversationNotificationDetail.md +16 -0
  375. data/docs/EmailConversationNotificationEmailMediaParticipant.md +39 -0
  376. data/docs/EmailConversationNotificationErrorBody.md +22 -0
  377. data/docs/EmailConversationNotificationErrorInfo.md +22 -0
  378. data/docs/EmailConversationNotificationParticipants.md +39 -0
  379. data/docs/EmailConversationNotificationUriReference.md +14 -0
  380. data/docs/EmailConversationNotificationWrapup.md +18 -0
  381. data/docs/EmailMediaParticipant.md +39 -0
  382. data/docs/EmailMediaPolicy.md +14 -0
  383. data/docs/EmailMediaPolicyConditions.md +17 -0
  384. data/docs/EmailMessage.md +24 -0
  385. data/docs/EmailMessageListing.md +22 -0
  386. data/docs/EmailSetup.md +13 -0
  387. data/docs/Empty.md +12 -0
  388. data/docs/EncryptionKey.md +18 -0
  389. data/docs/EncryptionKeyEntityListing.md +22 -0
  390. data/docs/Endpoint.md +30 -0
  391. data/docs/EndpointEntityListing.md +22 -0
  392. data/docs/Entry.md +14 -0
  393. data/docs/ErrorBody.md +22 -0
  394. data/docs/ErrorDetails.md +20 -0
  395. data/docs/EstimatedWaitTimePredictions.md +13 -0
  396. data/docs/Evaluation.md +32 -0
  397. data/docs/EvaluationAssignment.md +14 -0
  398. data/docs/EvaluationEntityListing.md +22 -0
  399. data/docs/EvaluationForm.md +21 -0
  400. data/docs/EvaluationFormAndScoringSet.md +14 -0
  401. data/docs/EvaluationFormEntityListing.md +22 -0
  402. data/docs/EvaluationScoringSet.md +18 -0
  403. data/docs/EvaluatorActivity.md +22 -0
  404. data/docs/EvaluatorActivityEntityListing.md +22 -0
  405. data/docs/ExpansionCriterium.md +14 -0
  406. data/docs/ExportUri.md +14 -0
  407. data/docs/ExportUriNotification.md +15 -0
  408. data/docs/Extension.md +28 -0
  409. data/docs/ExtensionEntityListing.md +22 -0
  410. data/docs/ExtensionPool.md +26 -0
  411. data/docs/ExtensionPoolEntityListing.md +22 -0
  412. data/docs/ExternalContact.md +32 -0
  413. data/docs/ExternalContactsApi.md +1886 -0
  414. data/docs/ExternalDataSource.md +14 -0
  415. data/docs/ExternalOrganization.md +30 -0
  416. data/docs/ExternalOrganizationListing.md +22 -0
  417. data/docs/FacetEntry.md +20 -0
  418. data/docs/FacetInfo.md +14 -0
  419. data/docs/FacetKeyAttribute.md +15 -0
  420. data/docs/FacetStatistics.md +19 -0
  421. data/docs/FacetTerm.md +18 -0
  422. data/docs/FailedObject.md +16 -0
  423. data/docs/FaxApi.md +371 -0
  424. data/docs/FaxDataV2Notification.md +29 -0
  425. data/docs/FaxDataV2NotificationLockData.md +15 -0
  426. data/docs/FaxDataV2NotificationLockInfo.md +15 -0
  427. data/docs/FaxDataV2NotificationUserData.md +14 -0
  428. data/docs/FaxDataV2NotificationWorkspaceData.md +13 -0
  429. data/docs/FaxDocument.md +30 -0
  430. data/docs/FaxDocumentEntityListing.md +22 -0
  431. data/docs/FaxSendRequest.md +21 -0
  432. data/docs/FaxSendResponse.md +17 -0
  433. data/docs/FaxStatus.md +20 -0
  434. data/docs/FaxSummary.md +15 -0
  435. data/docs/FeatureState.md +13 -0
  436. data/docs/FieldConfig.md +20 -0
  437. data/docs/FieldConfigs.md +16 -0
  438. data/docs/FieldList.md +21 -0
  439. data/docs/Flow.md +28 -0
  440. data/docs/FlowEntityListing.md +22 -0
  441. data/docs/FlowVersion.md +24 -0
  442. data/docs/FlowVersionEntityListing.md +22 -0
  443. data/docs/GSuite.md +20 -0
  444. data/docs/Geolocation.md +23 -0
  445. data/docs/GeolocationApi.md +255 -0
  446. data/docs/GeolocationNotification.md +17 -0
  447. data/docs/GeolocationSettings.md +17 -0
  448. data/docs/Greeting.md +24 -0
  449. data/docs/GreetingAudioFile.md +15 -0
  450. data/docs/GreetingListing.md +22 -0
  451. data/docs/GreetingMediaInfo.md +15 -0
  452. data/docs/GreetingOwner.md +15 -0
  453. data/docs/GreetingsApi.md +999 -0
  454. data/docs/Group.md +25 -0
  455. data/docs/GroupContact.md +16 -0
  456. data/docs/GroupEntityListing.md +22 -0
  457. data/docs/GroupMembersUpdate.md +14 -0
  458. data/docs/GroupSearchCriteria.md +20 -0
  459. data/docs/GroupSearchRequest.md +17 -0
  460. data/docs/GroupUpdate.md +22 -0
  461. data/docs/GroupsApi.md +700 -0
  462. data/docs/GroupsSearchResponse.md +21 -0
  463. data/docs/HeartBeatAlert.md +24 -0
  464. data/docs/HeartBeatAlertContainer.md +22 -0
  465. data/docs/HeartBeatAlertNotification.md +22 -0
  466. data/docs/HeartBeatAlertNotificationNotificationUser.md +14 -0
  467. data/docs/HeartBeatAlertNotificationNotificationUsers.md +14 -0
  468. data/docs/HeartBeatRule.md +22 -0
  469. data/docs/HeartBeatRuleContainer.md +22 -0
  470. data/docs/HeartBeatRuleNotification.md +21 -0
  471. data/docs/HeartBeatRuleNotificationNotificationUser.md +14 -0
  472. data/docs/IdentityNow.md +20 -0
  473. data/docs/IdentityProviderApi.md +1578 -0
  474. data/docs/ImportStatus.md +17 -0
  475. data/docs/ImportStatusNotification.md +18 -0
  476. data/docs/InboundDomain.md +17 -0
  477. data/docs/InboundDomainEntityListing.md +22 -0
  478. data/docs/InboundRoute.md +23 -0
  479. data/docs/InboundRouteEntityListing.md +22 -0
  480. data/docs/InitiateScreenRecording.md +15 -0
  481. data/docs/InteractionStatAlertNotification.md +28 -0
  482. data/docs/InteractionStatAlertNotificationNotificationUser.md +14 -0
  483. data/docs/InteractionStatRuleNotification.md +26 -0
  484. data/docs/InteractionStatRuleNotificationNotificationUser.md +14 -0
  485. data/docs/InteractionStatsAlert.md +29 -0
  486. data/docs/InteractionStatsAlertContainer.md +22 -0
  487. data/docs/InteractionStatsRule.md +26 -0
  488. data/docs/InteractionStatsRuleContainer.md +22 -0
  489. data/docs/IntradayDataUpdateNotification.md +19 -0
  490. data/docs/IntradayDataUpdateNotificationForecastDataPerInterval.md +15 -0
  491. data/docs/IntradayDataUpdateNotificationHistoricalAgentDataPerInterval.md +14 -0
  492. data/docs/IntradayDataUpdateNotificationHistoricalQueueDataPerInterval.md +20 -0
  493. data/docs/IntradayDataUpdateNotificationIntradayDataGroup.md +19 -0
  494. data/docs/IntradayDataUpdateNotificationIntradayDataGroupings.md +19 -0
  495. data/docs/IntradayDataUpdateNotificationIntradayForecastData.md +15 -0
  496. data/docs/IntradayDataUpdateNotificationIntradayHistoricalAgentData.md +14 -0
  497. data/docs/IntradayDataUpdateNotificationIntradayHistoricalQueueData.md +20 -0
  498. data/docs/IntradayDataUpdateNotificationIntradayMetric.md +14 -0
  499. data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionAgentData.md +13 -0
  500. data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionQueueData.md +15 -0
  501. data/docs/IntradayDataUpdateNotificationIntradayScheduleData.md +14 -0
  502. data/docs/IntradayDataUpdateNotificationMetrics.md +14 -0
  503. data/docs/IntradayDataUpdateNotificationPerformancePredictionAgentDataPerInterval.md +13 -0
  504. data/docs/IntradayDataUpdateNotificationPerformancePredictionQueueDataPerInterval.md +15 -0
  505. data/docs/IntradayDataUpdateNotificationScheduleDataPerInterval.md +14 -0
  506. data/docs/JsonNode.md +33 -0
  507. data/docs/JsonNodeSearchResponse.md +22 -0
  508. data/docs/JsonSchemaDocument.md +19 -0
  509. data/docs/KeyRotationSchedule.md +16 -0
  510. data/docs/Keyword.md +25 -0
  511. data/docs/KeywordSet.md +21 -0
  512. data/docs/KeywordSetEntityListing.md +22 -0
  513. data/docs/Language.md +18 -0
  514. data/docs/LanguageEntityListing.md +22 -0
  515. data/docs/LanguagesApi.md +611 -0
  516. data/docs/Library.md +18 -0
  517. data/docs/LibraryEntityListing.md +22 -0
  518. data/docs/LicenseApi.md +362 -0
  519. data/docs/LicenseAssignmentRequest.md +15 -0
  520. data/docs/LicenseBatchAssignmentRequest.md +13 -0
  521. data/docs/LicenseDefinition.md +17 -0
  522. data/docs/LicenseDefinitionListing.md +22 -0
  523. data/docs/LicenseOrganization.md +16 -0
  524. data/docs/LicenseUpdateResponse.md +13 -0
  525. data/docs/LicenseUpdateStatus.md +15 -0
  526. data/docs/LicenseUser.md +15 -0
  527. data/docs/Line.md +33 -0
  528. data/docs/LineBase.md +26 -0
  529. data/docs/LineBaseEntityListing.md +22 -0
  530. data/docs/LineEntityListing.md +22 -0
  531. data/docs/LineStatus.md +17 -0
  532. data/docs/LocalEncryptionConfiguration.md +18 -0
  533. data/docs/LocalEncryptionConfigurationListing.md +15 -0
  534. data/docs/LocalEncryptionKeyRequest.md +15 -0
  535. data/docs/Location.md +17 -0
  536. data/docs/LocationAddress.md +19 -0
  537. data/docs/LocationDefinition.md +21 -0
  538. data/docs/LocationEmergencyNumber.md +15 -0
  539. data/docs/LocationSearchCriteria.md +20 -0
  540. data/docs/LocationSearchRequest.md +17 -0
  541. data/docs/LocationsApi.md +261 -0
  542. data/docs/LocationsSearchResponse.md +21 -0
  543. data/docs/LockInfo.md +16 -0
  544. data/docs/LogicalInterfaceEntityListing.md +22 -0
  545. data/docs/ManagementUnit.md +18 -0
  546. data/docs/MaxParticipants.md +13 -0
  547. data/docs/MediaParticipantRequest.md +19 -0
  548. data/docs/MediaPolicies.md +15 -0
  549. data/docs/MediaResult.md +14 -0
  550. data/docs/MediaSetting.md +14 -0
  551. data/docs/MediaSummary.md +14 -0
  552. data/docs/MediaSummaryDetail.md +14 -0
  553. data/docs/MemberEntity.md +13 -0
  554. data/docs/MetaData.md +15 -0
  555. data/docs/Metabase.md +24 -0
  556. data/docs/MeteredEvaluationAssignment.md +18 -0
  557. data/docs/Note.md +20 -0
  558. data/docs/NoteListing.md +22 -0
  559. data/docs/NotificationsApi.md +426 -0
  560. data/docs/Number.md +14 -0
  561. data/docs/NumberPlan.md +31 -0
  562. data/docs/NumericRange.md +16 -0
  563. data/docs/OAuthApi.md +368 -0
  564. data/docs/OAuthClient.md +21 -0
  565. data/docs/OAuthClientEntityListing.md +22 -0
  566. data/docs/OAuthClientListing.md +20 -0
  567. data/docs/OAuthProvider.md +16 -0
  568. data/docs/OAuthProviderEntityListing.md +22 -0
  569. data/docs/ObservationDataContainer.md +14 -0
  570. data/docs/ObservationQuery.md +14 -0
  571. data/docs/ObservationQueryResponse.md +13 -0
  572. data/docs/Okta.md +19 -0
  573. data/docs/OneLogin.md +19 -0
  574. data/docs/Operation.md +21 -0
  575. data/docs/OrgMediaUtilization.md +15 -0
  576. data/docs/Organization.md +25 -0
  577. data/docs/OrganizationApi.md +250 -0
  578. data/docs/OrganizationFeatures.md +25 -0
  579. data/docs/OrganizationPresence.md +23 -0
  580. data/docs/OrganizationPresenceEntityListing.md +22 -0
  581. data/docs/OrganizationProductEntityListing.md +17 -0
  582. data/docs/OrganizationRoleEntityListing.md +22 -0
  583. data/docs/OrphanRecording.md +24 -0
  584. data/docs/OrphanRecordingListing.md +22 -0
  585. data/docs/OrphanUpdateRequest.md +15 -0
  586. data/docs/OutOfOffice.md +19 -0
  587. data/docs/OutOfOfficeNotification.md +17 -0
  588. data/docs/OutOfOfficeNotificationUser.md +13 -0
  589. data/docs/OutboundApi.md +4766 -0
  590. data/docs/OutboundRoute.md +30 -0
  591. data/docs/OutboundRouteBase.md +28 -0
  592. data/docs/OutboundRouteBaseEntityListing.md +22 -0
  593. data/docs/OutboundRouteEntityListing.md +22 -0
  594. data/docs/PINConfiguration.md +14 -0
  595. data/docs/Page.md +20 -0
  596. data/docs/PagingSpec.md +14 -0
  597. data/docs/Parameter.md +16 -0
  598. data/docs/ParsedCertificate.md +13 -0
  599. data/docs/Participant.md +48 -0
  600. data/docs/ParticipantAttributes.md +13 -0
  601. data/docs/ParticipantBasic.md +48 -0
  602. data/docs/PermissionCollectionEntityListing.md +22 -0
  603. data/docs/Permissions.md +15 -0
  604. data/docs/Phone.md +37 -0
  605. data/docs/PhoneBase.md +28 -0
  606. data/docs/PhoneBaseEntityListing.md +22 -0
  607. data/docs/PhoneCapabilities.md +18 -0
  608. data/docs/PhoneColumn.md +14 -0
  609. data/docs/PhoneEntityListing.md +22 -0
  610. data/docs/PhoneMetaBaseEntityListing.md +22 -0
  611. data/docs/PhoneNumber.md +18 -0
  612. data/docs/PhoneNumberColumn.md +14 -0
  613. data/docs/PhoneNumberStatus.md +13 -0
  614. data/docs/PhoneStatus.md +22 -0
  615. data/docs/PhonesReboot.md +14 -0
  616. data/docs/PhysicalInterfaceEntityListing.md +22 -0
  617. data/docs/PingIdentity.md +20 -0
  618. data/docs/Policy.md +24 -0
  619. data/docs/PolicyActions.md +20 -0
  620. data/docs/PolicyConditions.md +20 -0
  621. data/docs/PolicyCreate.md +24 -0
  622. data/docs/PolicyEntityListing.md +22 -0
  623. data/docs/PolicyErrorMessage.md +19 -0
  624. data/docs/PolicyErrors.md +13 -0
  625. data/docs/PredictionResults.md +15 -0
  626. data/docs/PresenceApi.md +508 -0
  627. data/docs/PresenceQueryResponse.md +14 -0
  628. data/docs/Prompt.md +18 -0
  629. data/docs/PromptAsset.md +24 -0
  630. data/docs/PromptAssetCreate.md +24 -0
  631. data/docs/PromptAssetEntityListing.md +22 -0
  632. data/docs/PromptEntityListing.md +22 -0
  633. data/docs/PropertyIndexRequest.md +15 -0
  634. data/docs/ProvisionInfo.md +15 -0
  635. data/docs/PureCloud.md +16 -0
  636. data/docs/QualifierMappingObservationQueryResponse.md +14 -0
  637. data/docs/QualityApi.md +2084 -0
  638. data/docs/QualityAudit.md +23 -0
  639. data/docs/QualityAuditPage.md +22 -0
  640. data/docs/QueryFacetInfo.md +14 -0
  641. data/docs/QueryRequest.md +20 -0
  642. data/docs/QueryResult.md +16 -0
  643. data/docs/QueryResults.md +14 -0
  644. data/docs/Question.md +24 -0
  645. data/docs/QuestionGroup.md +22 -0
  646. data/docs/QuestionGroupScore.md +23 -0
  647. data/docs/QuestionScore.md +18 -0
  648. data/docs/Queue.md +34 -0
  649. data/docs/QueueEmailAddress.md +14 -0
  650. data/docs/QueueEntityListing.md +22 -0
  651. data/docs/QueueMember.md +20 -0
  652. data/docs/QueueMemberEntityListing.md +22 -0
  653. data/docs/QueueMemberNotification.md +16 -0
  654. data/docs/QueueUtilizationDiagnostic.md +21 -0
  655. data/docs/Reaction.md +15 -0
  656. data/docs/RecallEntry.md +14 -0
  657. data/docs/Recording.md +34 -0
  658. data/docs/RecordingApi.md +2089 -0
  659. data/docs/RecordingDataV2Notification.md +29 -0
  660. data/docs/RecordingDataV2NotificationConversationData.md +13 -0
  661. data/docs/RecordingDataV2NotificationLockData.md +15 -0
  662. data/docs/RecordingDataV2NotificationLockInfo.md +15 -0
  663. data/docs/RecordingDataV2NotificationUserData.md +14 -0
  664. data/docs/RecordingDataV2NotificationWorkspaceData.md +13 -0
  665. data/docs/RecordingEmailMessage.md +22 -0
  666. data/docs/RecordingSettings.md +13 -0
  667. data/docs/Relationship.md +19 -0
  668. data/docs/RelationshipListing.md +22 -0
  669. data/docs/ReplaceRequest.md +15 -0
  670. data/docs/ReplaceResponse.md +18 -0
  671. data/docs/ReportMetaData.md +21 -0
  672. data/docs/ReportMetaDataEntityListing.md +22 -0
  673. data/docs/ReportRunEntry.md +23 -0
  674. data/docs/ReportRunEntryEntityDomainListing.md +22 -0
  675. data/docs/ReportSchedule.md +29 -0
  676. data/docs/ReportScheduleEntityListing.md +22 -0
  677. data/docs/ResourceConditionNode.md +17 -0
  678. data/docs/ResourceConditionValue.md +14 -0
  679. data/docs/ResourcePermissionPolicy.md +23 -0
  680. data/docs/Response.md +23 -0
  681. data/docs/ResponseEntityList.md +22 -0
  682. data/docs/ResponseEntityListing.md +22 -0
  683. data/docs/ResponseFilter.md +15 -0
  684. data/docs/ResponseManagementApi.md +699 -0
  685. data/docs/ResponseQueryRequest.md +15 -0
  686. data/docs/ResponseQueryResults.md +13 -0
  687. data/docs/ResponseSet.md +19 -0
  688. data/docs/ResponseSetEntityListing.md +22 -0
  689. data/docs/ResponseSetNotification.md +19 -0
  690. data/docs/ResponseSetNotificationReaction.md +16 -0
  691. data/docs/ResponseSetNotificationResponses.md +16 -0
  692. data/docs/ResponseSubstitution.md +15 -0
  693. data/docs/ResponseText.md +14 -0
  694. data/docs/RestErrorDetail.md +14 -0
  695. data/docs/RetentionDuration.md +14 -0
  696. data/docs/ReverseWhitepagesLookupResult.md +14 -0
  697. data/docs/Ring.md +14 -0
  698. data/docs/RoutingApi.md +2763 -0
  699. data/docs/RoutingData.md +17 -0
  700. data/docs/RoutingSkill.md +18 -0
  701. data/docs/RoutingStatus.md +15 -0
  702. data/docs/RoutingStatusAlert.md +23 -0
  703. data/docs/RoutingStatusAlertContainer.md +22 -0
  704. data/docs/RoutingStatusRule.md +22 -0
  705. data/docs/RoutingStatusRuleContainer.md +22 -0
  706. data/docs/RuleSet.md +21 -0
  707. data/docs/RuleSetDiagnostic.md +14 -0
  708. data/docs/RuleSetEntityListing.md +22 -0
  709. data/docs/RuleSetNotification.md +21 -0
  710. data/docs/RuleSetNotificationAction.md +17 -0
  711. data/docs/RuleSetNotificationActions.md +17 -0
  712. data/docs/RuleSetNotificationCondition.md +20 -0
  713. data/docs/RuleSetNotificationConditions.md +20 -0
  714. data/docs/RuleSetNotificationRule.md +19 -0
  715. data/docs/RuleSetNotificationRules.md +19 -0
  716. data/docs/RuleSetNotificationUriReference.md +14 -0
  717. data/docs/RunNowResponse.md +15 -0
  718. data/docs/Salesforce.md +19 -0
  719. data/docs/ScheduleInterval.md +14 -0
  720. data/docs/SchemaCategory.md +24 -0
  721. data/docs/SchemaCategoryEntityListing.md +22 -0
  722. data/docs/SchemaReferenceEntityListing.md +22 -0
  723. data/docs/ScreenRecordingSession.md +19 -0
  724. data/docs/ScreenRecordingSessionListing.md +22 -0
  725. data/docs/ScreenRecordingSessionRequest.md +15 -0
  726. data/docs/ScreenShareConversationNotification.md +16 -0
  727. data/docs/ScreenShareConversationNotificationDetail.md +16 -0
  728. data/docs/ScreenShareConversationNotificationErrorBody.md +22 -0
  729. data/docs/ScreenShareConversationNotificationErrorInfo.md +22 -0
  730. data/docs/ScreenShareConversationNotificationParticipants.md +40 -0
  731. data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +40 -0
  732. data/docs/ScreenShareConversationNotificationUriReference.md +14 -0
  733. data/docs/ScreenShareConversationNotificationWrapup.md +18 -0
  734. data/docs/Screenshare.md +22 -0
  735. data/docs/Script.md +26 -0
  736. data/docs/ScriptEntityListing.md +22 -0
  737. data/docs/ScriptsApi.md +592 -0
  738. data/docs/SearchAggregation.md +18 -0
  739. data/docs/SearchApi.md +888 -0
  740. data/docs/SearchCriteria.md +20 -0
  741. data/docs/SearchRequest.md +21 -0
  742. data/docs/Section.md +16 -0
  743. data/docs/SecurityProfile.md +16 -0
  744. data/docs/SecurityProfileEntityListing.md +22 -0
  745. data/docs/Segment.md +17 -0
  746. data/docs/SequenceSchedule.md +21 -0
  747. data/docs/SequenceScheduleNotification.md +21 -0
  748. data/docs/SequenceScheduleNotificationScheduleInterval.md +15 -0
  749. data/docs/SequenceScheduleNotificationUriReference.md +14 -0
  750. data/docs/ServerDate.md +13 -0
  751. data/docs/ServiceContext.md +13 -0
  752. data/docs/ServiceLevel.md +14 -0
  753. data/docs/Share.md +23 -0
  754. data/docs/ShareEntityListing.md +22 -0
  755. data/docs/SharedEntity.md +13 -0
  756. data/docs/SharedResponse.md +17 -0
  757. data/docs/Site.md +33 -0
  758. data/docs/SiteEntityListing.md +22 -0
  759. data/docs/SkillEntityListing.md +22 -0
  760. data/docs/SkillsToRemove.md +15 -0
  761. data/docs/SocialConversationNotification.md +16 -0
  762. data/docs/SocialConversationNotificationDetail.md +16 -0
  763. data/docs/SocialConversationNotificationErrorBody.md +22 -0
  764. data/docs/SocialConversationNotificationErrorInfo.md +22 -0
  765. data/docs/SocialConversationNotificationParticipants.md +41 -0
  766. data/docs/SocialConversationNotificationSocialMediaParticipant.md +41 -0
  767. data/docs/SocialConversationNotificationUriReference.md +14 -0
  768. data/docs/SocialConversationNotificationWrapup.md +18 -0
  769. data/docs/SocialExpression.md +26 -0
  770. data/docs/SortItem.md +14 -0
  771. data/docs/Station.md +22 -0
  772. data/docs/StationEntityListing.md +22 -0
  773. data/docs/StationsApi.md +203 -0
  774. data/docs/StatisticalResponse.md +15 -0
  775. data/docs/StatisticalSummary.md +21 -0
  776. data/docs/StreetAddress.md +20 -0
  777. data/docs/SubscriberResponse.md +14 -0
  778. data/docs/SuggestApi.md +272 -0
  779. data/docs/SuggestSearchCriteria.md +19 -0
  780. data/docs/SuggestSearchRequest.md +15 -0
  781. data/docs/SystemPresence.md +15 -0
  782. data/docs/SystemPrompt.md +17 -0
  783. data/docs/SystemPromptAsset.md +25 -0
  784. data/docs/SystemPromptAssetEntityListing.md +22 -0
  785. data/docs/SystemPromptEntityListing.md +22 -0
  786. data/docs/TagQueryRequest.md +15 -0
  787. data/docs/TagValue.md +17 -0
  788. data/docs/TagValueEntityListing.md +22 -0
  789. data/docs/TelephonyProvidersEdgeApi.md +7507 -0
  790. data/docs/TermAttribute.md +15 -0
  791. data/docs/Ticker.md +14 -0
  792. data/docs/TimeAllowed.md +15 -0
  793. data/docs/TimeInterval.md +14 -0
  794. data/docs/TimeOffRequest.md +30 -0
  795. data/docs/TimeOffRequestList.md +16 -0
  796. data/docs/TimeOffRequestPatch.md +13 -0
  797. data/docs/TimeOffRequestUpdateNotification.md +28 -0
  798. data/docs/TimeOffRequestUpdateNotificationUser.md +13 -0
  799. data/docs/TimeSlot.md +15 -0
  800. data/docs/TimeZone.md +16 -0
  801. data/docs/TimeZoneEntityListing.md +22 -0
  802. data/docs/TokensApi.md +66 -0
  803. data/docs/TransferRequest.md +17 -0
  804. data/docs/Trunk.md +31 -0
  805. data/docs/TrunkBase.md +28 -0
  806. data/docs/TrunkBaseAssignment.md +14 -0
  807. data/docs/TrunkBaseEntityListing.md +22 -0
  808. data/docs/TrunkEntityListing.md +22 -0
  809. data/docs/TrunkMetabaseEntityListing.md +22 -0
  810. data/docs/TrunkRecordingEnabledCount.md +14 -0
  811. data/docs/TwitterId.md +17 -0
  812. data/docs/UnreadMetric.md +13 -0
  813. data/docs/UnreadStatus.md +13 -0
  814. data/docs/UriReference.md +15 -0
  815. data/docs/Usage.md +13 -0
  816. data/docs/UsageItem.md +15 -0
  817. data/docs/User.md +36 -0
  818. data/docs/UserAgentInfo.md +15 -0
  819. data/docs/UserAuthorization.md +15 -0
  820. data/docs/UserConversationSummary.md +19 -0
  821. data/docs/UserConversationSummaryNotification.md +19 -0
  822. data/docs/UserConversationSummaryNotificationCall.md +14 -0
  823. data/docs/UserConversationSummaryNotificationCallContactCenter.md +14 -0
  824. data/docs/UserConversationSummaryNotificationMediaSummary.md +14 -0
  825. data/docs/UserConversationSummaryNotificationMediaSummaryDetail.md +14 -0
  826. data/docs/UserDetailsQuery.md +20 -0
  827. data/docs/UserEntityListing.md +22 -0
  828. data/docs/UserImage.md +14 -0
  829. data/docs/UserListScheduleRequestBody.md +15 -0
  830. data/docs/UserMe.md +48 -0
  831. data/docs/UserParam.md +14 -0
  832. data/docs/UserPresence.md +20 -0
  833. data/docs/UserPresenceAlert.md +25 -0
  834. data/docs/UserPresenceAlertContainer.md +22 -0
  835. data/docs/UserPresenceNotification.md +16 -0
  836. data/docs/UserPresenceNotificationOrganizationPresence.md +14 -0
  837. data/docs/UserPresenceNotificationPresenceDefinition.md +14 -0
  838. data/docs/UserPresenceRule.md +23 -0
  839. data/docs/UserPresenceRuleContainer.md +22 -0
  840. data/docs/UserQueue.md +35 -0
  841. data/docs/UserQueueEntityListing.md +22 -0
  842. data/docs/UserRecording.md +25 -0
  843. data/docs/UserRecordingEntityListing.md +22 -0
  844. data/docs/UserRecordingsApi.md +385 -0
  845. data/docs/UserRoutingSkill.md +18 -0
  846. data/docs/UserRoutingSkillPost.md +16 -0
  847. data/docs/UserRoutingStatusNotification.md +13 -0
  848. data/docs/UserRoutingStatusNotificationRoutingStatus.md +14 -0
  849. data/docs/UserSchedule.md +14 -0
  850. data/docs/UserScheduleActivity.md +18 -0
  851. data/docs/UserScheduleAdherence.md +26 -0
  852. data/docs/UserScheduleAdherenceUpdateNotification.md +22 -0
  853. data/docs/UserScheduleAdherenceUpdateNotificationUser.md +13 -0
  854. data/docs/UserScheduleContainer.md +14 -0
  855. data/docs/UserScheduleFullDayTimeOffMarker.md +17 -0
  856. data/docs/UserScheduleShift.md +15 -0
  857. data/docs/UserSearchCriteria.md +20 -0
  858. data/docs/UserSearchRequest.md +18 -0
  859. data/docs/UserSkillEntityListing.md +22 -0
  860. data/docs/UserStation.md +19 -0
  861. data/docs/UserStations.md +16 -0
  862. data/docs/UserStationsNotification.md +13 -0
  863. data/docs/UserStationsNotificationAssociatedStation.md +15 -0
  864. data/docs/UserStationsNotificationUser.md +13 -0
  865. data/docs/UserStationsNotificationUserStation.md +15 -0
  866. data/docs/UsersApi.md +2641 -0
  867. data/docs/UsersSearchResponse.md +21 -0
  868. data/docs/UtilitiesApi.md +189 -0
  869. data/docs/Utilization.md +13 -0
  870. data/docs/ValidateAddressRequest.md +13 -0
  871. data/docs/ValidateAddressResponse.md +14 -0
  872. data/docs/Video.md +23 -0
  873. data/docs/VideoConversationNotification.md +16 -0
  874. data/docs/VideoConversationNotificationDetail.md +16 -0
  875. data/docs/VideoConversationNotificationErrorBody.md +22 -0
  876. data/docs/VideoConversationNotificationErrorInfo.md +22 -0
  877. data/docs/VideoConversationNotificationParticipants.md +42 -0
  878. data/docs/VideoConversationNotificationUriReference.md +14 -0
  879. data/docs/VideoConversationNotificationVideoMediaParticipant.md +42 -0
  880. data/docs/VideoConversationNotificationWrapup.md +18 -0
  881. data/docs/VisibilityCondition.md +14 -0
  882. data/docs/VmPairingInfo.md +16 -0
  883. data/docs/VoicemailApi.md +1336 -0
  884. data/docs/VoicemailCopyRecord.md +15 -0
  885. data/docs/VoicemailGroupPolicy.md +18 -0
  886. data/docs/VoicemailMailboxInfo.md +18 -0
  887. data/docs/VoicemailMediaInfo.md +15 -0
  888. data/docs/VoicemailMessage.md +29 -0
  889. data/docs/VoicemailMessageEntityListing.md +22 -0
  890. data/docs/VoicemailMessageNotification.md +24 -0
  891. data/docs/VoicemailOrganizationPolicy.md +19 -0
  892. data/docs/VoicemailSearchCriteria.md +20 -0
  893. data/docs/VoicemailSearchRequest.md +18 -0
  894. data/docs/VoicemailUserPolicy.md +16 -0
  895. data/docs/VoicemailsSearchResponse.md +21 -0
  896. data/docs/WfmUserEntityListing.md +13 -0
  897. data/docs/WorkforceManagementApi.md +699 -0
  898. data/docs/Workspace.md +24 -0
  899. data/docs/WorkspaceCreate.md +15 -0
  900. data/docs/WorkspaceEntityListing.md +22 -0
  901. data/docs/WorkspaceMember.md +21 -0
  902. data/docs/WorkspaceMemberEntityListing.md +22 -0
  903. data/docs/WorkspaceSummary.md +14 -0
  904. data/docs/WrapUpCodeMapping.md +20 -0
  905. data/docs/WrapUpCodeMappingNotification.md +19 -0
  906. data/docs/Wrapup.md +19 -0
  907. data/docs/WrapupCode.md +19 -0
  908. data/docs/WrapupCodeEntityListing.md +22 -0
  909. data/git_push.sh +52 -0
  910. data/lib/purecloudplatformclientv2.rb +949 -0
  911. data/lib/purecloudplatformclientv2/api/alerting_api.rb +2016 -0
  912. data/lib/purecloudplatformclientv2/api/analytics_api.rb +1301 -0
  913. data/lib/purecloudplatformclientv2/api/architect_api.rb +2860 -0
  914. data/lib/purecloudplatformclientv2/api/attributes_api.rb +374 -0
  915. data/lib/purecloudplatformclientv2/api/authorization_api.rb +1043 -0
  916. data/lib/purecloudplatformclientv2/api/content_management_api.rb +2416 -0
  917. data/lib/purecloudplatformclientv2/api/conversations_api.rb +4725 -0
  918. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +1810 -0
  919. data/lib/purecloudplatformclientv2/api/fax_api.rb +370 -0
  920. data/lib/purecloudplatformclientv2/api/geolocation_api.rb +263 -0
  921. data/lib/purecloudplatformclientv2/api/greetings_api.rb +974 -0
  922. data/lib/purecloudplatformclientv2/api/groups_api.rb +696 -0
  923. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +1547 -0
  924. data/lib/purecloudplatformclientv2/api/languages_api.rb +604 -0
  925. data/lib/purecloudplatformclientv2/api/license_api.rb +357 -0
  926. data/lib/purecloudplatformclientv2/api/locations_api.rb +267 -0
  927. data/lib/purecloudplatformclientv2/api/notifications_api.rb +424 -0
  928. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +368 -0
  929. data/lib/purecloudplatformclientv2/api/organization_api.rb +262 -0
  930. data/lib/purecloudplatformclientv2/api/outbound_api.rb +4670 -0
  931. data/lib/purecloudplatformclientv2/api/presence_api.rb +505 -0
  932. data/lib/purecloudplatformclientv2/api/quality_api.rb +2069 -0
  933. data/lib/purecloudplatformclientv2/api/recording_api.rb +2042 -0
  934. data/lib/purecloudplatformclientv2/api/response_management_api.rb +693 -0
  935. data/lib/purecloudplatformclientv2/api/routing_api.rb +2690 -0
  936. data/lib/purecloudplatformclientv2/api/scripts_api.rb +597 -0
  937. data/lib/purecloudplatformclientv2/api/search_api.rb +862 -0
  938. data/lib/purecloudplatformclientv2/api/stations_api.rb +212 -0
  939. data/lib/purecloudplatformclientv2/api/suggest_api.rb +275 -0
  940. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +7258 -0
  941. data/lib/purecloudplatformclientv2/api/tokens_api.rb +80 -0
  942. data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +385 -0
  943. data/lib/purecloudplatformclientv2/api/users_api.rb +2557 -0
  944. data/lib/purecloudplatformclientv2/api/utilities_api.rb +196 -0
  945. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +1294 -0
  946. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +675 -0
  947. data/lib/purecloudplatformclientv2/api_client.rb +336 -0
  948. data/lib/purecloudplatformclientv2/api_error.rb +40 -0
  949. data/lib/purecloudplatformclientv2/configuration.rb +170 -0
  950. data/lib/purecloudplatformclientv2/models/actions.rb +180 -0
  951. data/lib/purecloudplatformclientv2/models/activity_code.rb +264 -0
  952. data/lib/purecloudplatformclientv2/models/activity_code_container.rb +182 -0
  953. data/lib/purecloudplatformclientv2/models/acw_settings.rb +203 -0
  954. data/lib/purecloudplatformclientv2/models/address.rb +219 -0
  955. data/lib/purecloudplatformclientv2/models/addressable_entity_user.rb +189 -0
  956. data/lib/purecloudplatformclientv2/models/addressable_license_definition.rb +189 -0
  957. data/lib/purecloudplatformclientv2/models/adfs.rb +243 -0
  958. data/lib/purecloudplatformclientv2/models/adjacents.rb +202 -0
  959. data/lib/purecloudplatformclientv2/models/agent.rb +179 -0
  960. data/lib/purecloudplatformclientv2/models/agent_activity.rb +236 -0
  961. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +261 -0
  962. data/lib/purecloudplatformclientv2/models/agent_evaluator_activity.rb +234 -0
  963. data/lib/purecloudplatformclientv2/models/aggregate_data_container.rb +192 -0
  964. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +210 -0
  965. data/lib/purecloudplatformclientv2/models/aggregate_query_response.rb +180 -0
  966. data/lib/purecloudplatformclientv2/models/aggregate_view_data.rb +187 -0
  967. data/lib/purecloudplatformclientv2/models/aggregation_query.rb +255 -0
  968. data/lib/purecloudplatformclientv2/models/aggregation_range.rb +189 -0
  969. data/lib/purecloudplatformclientv2/models/aggregation_result.rb +232 -0
  970. data/lib/purecloudplatformclientv2/models/aggregation_result_entry.rb +208 -0
  971. data/lib/purecloudplatformclientv2/models/analytics_conversation.rb +220 -0
  972. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +191 -0
  973. data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +427 -0
  974. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +259 -0
  975. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +248 -0
  976. data/lib/purecloudplatformclientv2/models/analytics_property.rb +225 -0
  977. data/lib/purecloudplatformclientv2/models/analytics_query_aggregation.rb +235 -0
  978. data/lib/purecloudplatformclientv2/models/analytics_query_clause.rb +213 -0
  979. data/lib/purecloudplatformclientv2/models/analytics_query_filter.rb +221 -0
  980. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +319 -0
  981. data/lib/purecloudplatformclientv2/models/analytics_routing_status_record.rb +223 -0
  982. data/lib/purecloudplatformclientv2/models/analytics_session.rb +490 -0
  983. data/lib/purecloudplatformclientv2/models/analytics_user_detail.rb +203 -0
  984. data/lib/purecloudplatformclientv2/models/analytics_user_details_query_response.rb +191 -0
  985. data/lib/purecloudplatformclientv2/models/analytics_user_presence_record.rb +233 -0
  986. data/lib/purecloudplatformclientv2/models/analytics_view.rb +235 -0
  987. data/lib/purecloudplatformclientv2/models/annotation.rb +355 -0
  988. data/lib/purecloudplatformclientv2/models/answer_option.rb +196 -0
  989. data/lib/purecloudplatformclientv2/models/archive_retention.rb +201 -0
  990. data/lib/purecloudplatformclientv2/models/attachment.rb +214 -0
  991. data/lib/purecloudplatformclientv2/models/attempt_limits.rb +280 -0
  992. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +261 -0
  993. data/lib/purecloudplatformclientv2/models/attempt_limits_notification.rb +293 -0
  994. data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entries.rb +196 -0
  995. data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entry.rb +196 -0
  996. data/lib/purecloudplatformclientv2/models/attribute.rb +259 -0
  997. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +261 -0
  998. data/lib/purecloudplatformclientv2/models/attribute_filter_item.rb +212 -0
  999. data/lib/purecloudplatformclientv2/models/attribute_query_request.rb +200 -0
  1000. data/lib/purecloudplatformclientv2/models/audit_change.rb +209 -0
  1001. data/lib/purecloudplatformclientv2/models/audit_entity.rb +213 -0
  1002. data/lib/purecloudplatformclientv2/models/audit_entity_reference.rb +228 -0
  1003. data/lib/purecloudplatformclientv2/models/audit_facet.rb +197 -0
  1004. data/lib/purecloudplatformclientv2/models/audit_filter.rb +227 -0
  1005. data/lib/purecloudplatformclientv2/models/audit_message.rb +349 -0
  1006. data/lib/purecloudplatformclientv2/models/audit_search_result.rb +231 -0
  1007. data/lib/purecloudplatformclientv2/models/audit_user.rb +203 -0
  1008. data/lib/purecloudplatformclientv2/models/available_language_list.rb +180 -0
  1009. data/lib/purecloudplatformclientv2/models/available_topic.rb +210 -0
  1010. data/lib/purecloudplatformclientv2/models/available_topic_entity_listing.rb +180 -0
  1011. data/lib/purecloudplatformclientv2/models/available_translations.rb +191 -0
  1012. data/lib/purecloudplatformclientv2/models/bullseye.rb +180 -0
  1013. data/lib/purecloudplatformclientv2/models/calibration.rb +320 -0
  1014. data/lib/purecloudplatformclientv2/models/calibration_assignment.rb +207 -0
  1015. data/lib/purecloudplatformclientv2/models/calibration_create.rb +325 -0
  1016. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +261 -0
  1017. data/lib/purecloudplatformclientv2/models/call.rb +418 -0
  1018. data/lib/purecloudplatformclientv2/models/call_basic.rb +418 -0
  1019. data/lib/purecloudplatformclientv2/models/call_command.rb +183 -0
  1020. data/lib/purecloudplatformclientv2/models/call_conversation.rb +245 -0
  1021. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +261 -0
  1022. data/lib/purecloudplatformclientv2/models/call_conversation_notification.rb +232 -0
  1023. data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +551 -0
  1024. data/lib/purecloudplatformclientv2/models/call_conversation_notification_detail.rb +205 -0
  1025. data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_body.rb +265 -0
  1026. data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_info.rb +265 -0
  1027. data/lib/purecloudplatformclientv2/models/call_conversation_notification_fax_status.rb +241 -0
  1028. data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +551 -0
  1029. data/lib/purecloudplatformclientv2/models/call_conversation_notification_uri_reference.rb +187 -0
  1030. data/lib/purecloudplatformclientv2/models/call_conversation_notification_wrapup.rb +225 -0
  1031. data/lib/purecloudplatformclientv2/models/call_forwarding.rb +235 -0
  1032. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +587 -0
  1033. data/lib/purecloudplatformclientv2/models/call_media_policy.rb +189 -0
  1034. data/lib/purecloudplatformclientv2/models/call_media_policy_conditions.rb +242 -0
  1035. data/lib/purecloudplatformclientv2/models/call_record.rb +189 -0
  1036. data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +213 -0
  1037. data/lib/purecloudplatformclientv2/models/callable_time.rb +195 -0
  1038. data/lib/purecloudplatformclientv2/models/callable_time_set.rb +244 -0
  1039. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +261 -0
  1040. data/lib/purecloudplatformclientv2/models/callable_time_set_notification.rb +234 -0
  1041. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_time.rb +198 -0
  1042. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_times.rb +198 -0
  1043. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slot.rb +205 -0
  1044. data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slots.rb +205 -0
  1045. data/lib/purecloudplatformclientv2/models/callback.rb +395 -0
  1046. data/lib/purecloudplatformclientv2/models/callback_basic.rb +395 -0
  1047. data/lib/purecloudplatformclientv2/models/callback_conversation.rb +222 -0
  1048. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +261 -0
  1049. data/lib/purecloudplatformclientv2/models/callback_conversation_notification.rb +209 -0
  1050. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +503 -0
  1051. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_detail.rb +205 -0
  1052. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_dialer_preview.rb +225 -0
  1053. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_body.rb +265 -0
  1054. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info.rb +265 -0
  1055. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info_details.rb +205 -0
  1056. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +503 -0
  1057. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_phone_number_column.rb +196 -0
  1058. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_uri_reference.rb +187 -0
  1059. data/lib/purecloudplatformclientv2/models/callback_conversation_notification_wrapup.rb +225 -0
  1060. data/lib/purecloudplatformclientv2/models/callback_identifier.rb +211 -0
  1061. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +535 -0
  1062. data/lib/purecloudplatformclientv2/models/campaign.rb +514 -0
  1063. data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +211 -0
  1064. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +261 -0
  1065. data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +384 -0
  1066. data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +233 -0
  1067. data/lib/purecloudplatformclientv2/models/campaign_notification.rb +488 -0
  1068. data/lib/purecloudplatformclientv2/models/campaign_notification_contact_sort.rb +219 -0
  1069. data/lib/purecloudplatformclientv2/models/campaign_notification_errors.rb +196 -0
  1070. data/lib/purecloudplatformclientv2/models/campaign_notification_phone_column.rb +196 -0
  1071. data/lib/purecloudplatformclientv2/models/campaign_notification_phone_columns.rb +196 -0
  1072. data/lib/purecloudplatformclientv2/models/campaign_notification_rest_error_detail.rb +196 -0
  1073. data/lib/purecloudplatformclientv2/models/campaign_notification_uri_reference.rb +187 -0
  1074. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +227 -0
  1075. data/lib/purecloudplatformclientv2/models/campaign_progress_notification.rb +214 -0
  1076. data/lib/purecloudplatformclientv2/models/campaign_progress_notification_uri_reference.rb +187 -0
  1077. data/lib/purecloudplatformclientv2/models/campaign_rule.rb +292 -0
  1078. data/lib/purecloudplatformclientv2/models/campaign_rule_action.rb +219 -0
  1079. data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +200 -0
  1080. data/lib/purecloudplatformclientv2/models/campaign_rule_condition.rb +210 -0
  1081. data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +191 -0
  1082. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +261 -0
  1083. data/lib/purecloudplatformclientv2/models/campaign_rule_notification.rb +272 -0
  1084. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action.rb +230 -0
  1085. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action_entities.rb +209 -0
  1086. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_actions.rb +230 -0
  1087. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_condition.rb +221 -0
  1088. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_conditions.rb +221 -0
  1089. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_entities.rb +191 -0
  1090. data/lib/purecloudplatformclientv2/models/campaign_rule_notification_uri_reference.rb +187 -0
  1091. data/lib/purecloudplatformclientv2/models/campaign_rule_parameters.rb +251 -0
  1092. data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +272 -0
  1093. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification.rb +252 -0
  1094. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_intervals.rb +196 -0
  1095. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_schedule_interval.rb +196 -0
  1096. data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_uri_reference.rb +187 -0
  1097. data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +306 -0
  1098. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +261 -0
  1099. data/lib/purecloudplatformclientv2/models/campaign_sequence_notification.rb +284 -0
  1100. data/lib/purecloudplatformclientv2/models/campaign_sequence_notification_uri_reference.rb +187 -0
  1101. data/lib/purecloudplatformclientv2/models/campaign_stats.rb +229 -0
  1102. data/lib/purecloudplatformclientv2/models/campaign_time_slot.rb +203 -0
  1103. data/lib/purecloudplatformclientv2/models/certificate.rb +184 -0
  1104. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +261 -0
  1105. data/lib/purecloudplatformclientv2/models/certificate_details.rb +238 -0
  1106. data/lib/purecloudplatformclientv2/models/change.rb +212 -0
  1107. data/lib/purecloudplatformclientv2/models/channel.rb +188 -0
  1108. data/lib/purecloudplatformclientv2/models/channel_entity_listing.rb +180 -0
  1109. data/lib/purecloudplatformclientv2/models/channel_topic.rb +189 -0
  1110. data/lib/purecloudplatformclientv2/models/channel_topic_entity_listing.rb +180 -0
  1111. data/lib/purecloudplatformclientv2/models/chat.rb +178 -0
  1112. data/lib/purecloudplatformclientv2/models/chat_conversation.rb +222 -0
  1113. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +261 -0
  1114. data/lib/purecloudplatformclientv2/models/chat_conversation_notification.rb +209 -0
  1115. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +447 -0
  1116. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_detail.rb +205 -0
  1117. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_body.rb +265 -0
  1118. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_info.rb +265 -0
  1119. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +447 -0
  1120. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_uri_reference.rb +187 -0
  1121. data/lib/purecloudplatformclientv2/models/chat_conversation_notification_wrapup.rb +225 -0
  1122. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +473 -0
  1123. data/lib/purecloudplatformclientv2/models/chat_media_policy.rb +189 -0
  1124. data/lib/purecloudplatformclientv2/models/chat_media_policy_conditions.rb +231 -0
  1125. data/lib/purecloudplatformclientv2/models/chat_message.rb +250 -0
  1126. data/lib/purecloudplatformclientv2/models/chat_message_user.rb +216 -0
  1127. data/lib/purecloudplatformclientv2/models/cobrowse_conversation.rb +222 -0
  1128. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +261 -0
  1129. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification.rb +209 -0
  1130. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +485 -0
  1131. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_detail.rb +205 -0
  1132. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_body.rb +265 -0
  1133. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_info.rb +265 -0
  1134. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +485 -0
  1135. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_uri_reference.rb +187 -0
  1136. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_wrapup.rb +225 -0
  1137. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +515 -0
  1138. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +331 -0
  1139. data/lib/purecloudplatformclientv2/models/command_status.rb +272 -0
  1140. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +261 -0
  1141. data/lib/purecloudplatformclientv2/models/condition.rb +283 -0
  1142. data/lib/purecloudplatformclientv2/models/connect_rate.rb +199 -0
  1143. data/lib/purecloudplatformclientv2/models/consult_transfer.rb +207 -0
  1144. data/lib/purecloudplatformclientv2/models/consult_transfer_response.rb +183 -0
  1145. data/lib/purecloudplatformclientv2/models/consult_transfer_update.rb +197 -0
  1146. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +261 -0
  1147. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +261 -0
  1148. data/lib/purecloudplatformclientv2/models/contact.rb +235 -0
  1149. data/lib/purecloudplatformclientv2/models/contact_address.rb +223 -0
  1150. data/lib/purecloudplatformclientv2/models/contact_callback_request.rb +239 -0
  1151. data/lib/purecloudplatformclientv2/models/contact_list.rb +312 -0
  1152. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +261 -0
  1153. data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +292 -0
  1154. data/lib/purecloudplatformclientv2/models/contact_list_notification_contact_phone_number_column.rb +205 -0
  1155. data/lib/purecloudplatformclientv2/models/contact_list_notification_import_status.rb +237 -0
  1156. data/lib/purecloudplatformclientv2/models/contact_list_notification_phone_columns.rb +205 -0
  1157. data/lib/purecloudplatformclientv2/models/contact_list_notification_uri_reference.rb +187 -0
  1158. data/lib/purecloudplatformclientv2/models/contact_listing.rb +261 -0
  1159. data/lib/purecloudplatformclientv2/models/contact_phone_number_column.rb +207 -0
  1160. data/lib/purecloudplatformclientv2/models/contact_sort.rb +212 -0
  1161. data/lib/purecloudplatformclientv2/models/content_attribute_filter_item.rb +212 -0
  1162. data/lib/purecloudplatformclientv2/models/content_facet_filter_item.rb +235 -0
  1163. data/lib/purecloudplatformclientv2/models/content_filter_item.rb +235 -0
  1164. data/lib/purecloudplatformclientv2/models/content_query_request.rb +249 -0
  1165. data/lib/purecloudplatformclientv2/models/content_sort_item.rb +187 -0
  1166. data/lib/purecloudplatformclientv2/models/conversation.rb +318 -0
  1167. data/lib/purecloudplatformclientv2/models/conversation_association.rb +225 -0
  1168. data/lib/purecloudplatformclientv2/models/conversation_basic.rb +233 -0
  1169. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +333 -0
  1170. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +261 -0
  1171. data/lib/purecloudplatformclientv2/models/conversation_notification.rb +216 -0
  1172. data/lib/purecloudplatformclientv2/models/conversation_notification_address.rb +223 -0
  1173. data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +407 -0
  1174. data/lib/purecloudplatformclientv2/models/conversation_notification_callback.rb +375 -0
  1175. data/lib/purecloudplatformclientv2/models/conversation_notification_callbacks.rb +375 -0
  1176. data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +407 -0
  1177. data/lib/purecloudplatformclientv2/models/conversation_notification_chat.rb +287 -0
  1178. data/lib/purecloudplatformclientv2/models/conversation_notification_chats.rb +287 -0
  1179. data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowse.rb +325 -0
  1180. data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowsesessions.rb +325 -0
  1181. data/lib/purecloudplatformclientv2/models/conversation_notification_dialer_preview.rb +225 -0
  1182. data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reason.rb +210 -0
  1183. data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reasons.rb +210 -0
  1184. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +305 -0
  1185. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +305 -0
  1186. data/lib/purecloudplatformclientv2/models/conversation_notification_error_details.rb +243 -0
  1187. data/lib/purecloudplatformclientv2/models/conversation_notification_error_info.rb +243 -0
  1188. data/lib/purecloudplatformclientv2/models/conversation_notification_fax_status.rb +241 -0
  1189. data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +439 -0
  1190. data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +439 -0
  1191. data/lib/purecloudplatformclientv2/models/conversation_notification_phone_number_column.rb +196 -0
  1192. data/lib/purecloudplatformclientv2/models/conversation_notification_screenshare.rb +287 -0
  1193. data/lib/purecloudplatformclientv2/models/conversation_notification_screenshares.rb +287 -0
  1194. data/lib/purecloudplatformclientv2/models/conversation_notification_self.rb +223 -0
  1195. data/lib/purecloudplatformclientv2/models/conversation_notification_social_expression.rb +323 -0
  1196. data/lib/purecloudplatformclientv2/models/conversation_notification_social_expressions.rb +323 -0
  1197. data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +305 -0
  1198. data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +305 -0
  1199. data/lib/purecloudplatformclientv2/models/conversation_notification_wrapup.rb +225 -0
  1200. data/lib/purecloudplatformclientv2/models/conversation_query.rb +285 -0
  1201. data/lib/purecloudplatformclientv2/models/copy_voicemail_message.rb +204 -0
  1202. data/lib/purecloudplatformclientv2/models/cover_sheet.rb +189 -0
  1203. data/lib/purecloudplatformclientv2/models/create_call_request.rb +265 -0
  1204. data/lib/purecloudplatformclientv2/models/create_call_response.rb +198 -0
  1205. data/lib/purecloudplatformclientv2/models/create_callback_command.rb +257 -0
  1206. data/lib/purecloudplatformclientv2/models/create_callback_response.rb +199 -0
  1207. data/lib/purecloudplatformclientv2/models/create_email_request.rb +315 -0
  1208. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +433 -0
  1209. data/lib/purecloudplatformclientv2/models/create_share_request.rb +255 -0
  1210. data/lib/purecloudplatformclientv2/models/create_share_request_member.rb +201 -0
  1211. data/lib/purecloudplatformclientv2/models/create_share_response.rb +302 -0
  1212. data/lib/purecloudplatformclientv2/models/create_user.rb +241 -0
  1213. data/lib/purecloudplatformclientv2/models/create_web_chat_request.rb +251 -0
  1214. data/lib/purecloudplatformclientv2/models/current_user_schedule_request_body.rb +198 -0
  1215. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +234 -0
  1216. data/lib/purecloudplatformclientv2/models/default_greeting_list.rb +279 -0
  1217. data/lib/purecloudplatformclientv2/models/delete_retention.rb +178 -0
  1218. data/lib/purecloudplatformclientv2/models/dependency.rb +248 -0
  1219. data/lib/purecloudplatformclientv2/models/dependency_object.rb +270 -0
  1220. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +261 -0
  1221. data/lib/purecloudplatformclientv2/models/dependency_status.rb +270 -0
  1222. data/lib/purecloudplatformclientv2/models/dependency_type.rb +207 -0
  1223. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +261 -0
  1224. data/lib/purecloudplatformclientv2/models/destination.rb +210 -0
  1225. data/lib/purecloudplatformclientv2/models/detail.rb +205 -0
  1226. data/lib/purecloudplatformclientv2/models/dialer_action.rb +261 -0
  1227. data/lib/purecloudplatformclientv2/models/dialer_audit_request.rb +215 -0
  1228. data/lib/purecloudplatformclientv2/models/dialer_contact.rb +258 -0
  1229. data/lib/purecloudplatformclientv2/models/dialer_preview.rb +220 -0
  1230. data/lib/purecloudplatformclientv2/models/dialer_rule.rb +259 -0
  1231. data/lib/purecloudplatformclientv2/models/did.rb +351 -0
  1232. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +261 -0
  1233. data/lib/purecloudplatformclientv2/models/did_pool.rb +361 -0
  1234. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +261 -0
  1235. data/lib/purecloudplatformclientv2/models/digit_length.rb +187 -0
  1236. data/lib/purecloudplatformclientv2/models/disconnect_reason.rb +213 -0
  1237. data/lib/purecloudplatformclientv2/models/dnc_list.rb +309 -0
  1238. data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +309 -0
  1239. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +261 -0
  1240. data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +293 -0
  1241. data/lib/purecloudplatformclientv2/models/dnc_list_notification_import_status.rb +237 -0
  1242. data/lib/purecloudplatformclientv2/models/document.rb +506 -0
  1243. data/lib/purecloudplatformclientv2/models/document_attribute.rb +189 -0
  1244. data/lib/purecloudplatformclientv2/models/document_audit.rb +374 -0
  1245. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +261 -0
  1246. data/lib/purecloudplatformclientv2/models/document_data_v2_notification.rb +295 -0
  1247. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_created_by.rb +187 -0
  1248. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_data.rb +196 -0
  1249. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_info.rb +196 -0
  1250. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_user_data.rb +187 -0
  1251. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace.rb +178 -0
  1252. data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace_data.rb +178 -0
  1253. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +261 -0
  1254. data/lib/purecloudplatformclientv2/models/document_thumbnail.rb +205 -0
  1255. data/lib/purecloudplatformclientv2/models/document_update.rb +267 -0
  1256. data/lib/purecloudplatformclientv2/models/document_upload.rb +219 -0
  1257. data/lib/purecloudplatformclientv2/models/documentation_result.rb +393 -0
  1258. data/lib/purecloudplatformclientv2/models/documentation_search_criteria.rb +287 -0
  1259. data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +234 -0
  1260. data/lib/purecloudplatformclientv2/models/documentation_search_response.rb +287 -0
  1261. data/lib/purecloudplatformclientv2/models/domain_capabilities.rb +229 -0
  1262. data/lib/purecloudplatformclientv2/models/domain_certificate_authority.rb +371 -0
  1263. data/lib/purecloudplatformclientv2/models/domain_edge_software_update_dto.rb +281 -0
  1264. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +244 -0
  1265. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +261 -0
  1266. data/lib/purecloudplatformclientv2/models/domain_entity.rb +198 -0
  1267. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +261 -0
  1268. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +261 -0
  1269. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +261 -0
  1270. data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +552 -0
  1271. data/lib/purecloudplatformclientv2/models/domain_network_address.rb +237 -0
  1272. data/lib/purecloudplatformclientv2/models/domain_network_command_response.rb +205 -0
  1273. data/lib/purecloudplatformclientv2/models/domain_network_route.rb +233 -0
  1274. data/lib/purecloudplatformclientv2/models/domain_org_role_difference.rb +220 -0
  1275. data/lib/purecloudplatformclientv2/models/domain_organization_product.rb +178 -0
  1276. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +275 -0
  1277. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +280 -0
  1278. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +280 -0
  1279. data/lib/purecloudplatformclientv2/models/domain_permission.rb +214 -0
  1280. data/lib/purecloudplatformclientv2/models/domain_permission_collection.rb +218 -0
  1281. data/lib/purecloudplatformclientv2/models/domain_permission_policy.rb +245 -0
  1282. data/lib/purecloudplatformclientv2/models/domain_physical_capabilities.rb +187 -0
  1283. data/lib/purecloudplatformclientv2/models/domain_physical_interface.rb +345 -0
  1284. data/lib/purecloudplatformclientv2/models/domain_resource_condition_node.rb +246 -0
  1285. data/lib/purecloudplatformclientv2/models/domain_resource_condition_value.rb +219 -0
  1286. data/lib/purecloudplatformclientv2/models/domain_role.rb +189 -0
  1287. data/lib/purecloudplatformclientv2/models/domain_schema_reference.rb +300 -0
  1288. data/lib/purecloudplatformclientv2/models/download_response.rb +198 -0
  1289. data/lib/purecloudplatformclientv2/models/duration_condition.rb +210 -0
  1290. data/lib/purecloudplatformclientv2/models/edge.rb +594 -0
  1291. data/lib/purecloudplatformclientv2/models/edge_auto_update_config.rb +207 -0
  1292. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +261 -0
  1293. data/lib/purecloudplatformclientv2/models/edge_group.rb +340 -0
  1294. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +261 -0
  1295. data/lib/purecloudplatformclientv2/models/edge_interface.rb +245 -0
  1296. data/lib/purecloudplatformclientv2/models/edge_line.rb +388 -0
  1297. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +261 -0
  1298. data/lib/purecloudplatformclientv2/models/edge_logs_job.rb +312 -0
  1299. data/lib/purecloudplatformclientv2/models/edge_logs_job_file.rb +374 -0
  1300. data/lib/purecloudplatformclientv2/models/edge_logs_job_request.rb +199 -0
  1301. data/lib/purecloudplatformclientv2/models/edge_logs_job_response.rb +300 -0
  1302. data/lib/purecloudplatformclientv2/models/edge_logs_job_upload_request.rb +185 -0
  1303. data/lib/purecloudplatformclientv2/models/edge_reboot_parameters.rb +179 -0
  1304. data/lib/purecloudplatformclientv2/models/edge_service_state_request.rb +193 -0
  1305. data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +353 -0
  1306. data/lib/purecloudplatformclientv2/models/edge_version_information.rb +178 -0
  1307. data/lib/purecloudplatformclientv2/models/edge_version_report.rb +187 -0
  1308. data/lib/purecloudplatformclientv2/models/email.rb +352 -0
  1309. data/lib/purecloudplatformclientv2/models/email_address.rb +187 -0
  1310. data/lib/purecloudplatformclientv2/models/email_attachment.rb +214 -0
  1311. data/lib/purecloudplatformclientv2/models/email_conversation.rb +222 -0
  1312. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +261 -0
  1313. data/lib/purecloudplatformclientv2/models/email_conversation_notification.rb +209 -0
  1314. data/lib/purecloudplatformclientv2/models/email_conversation_notification_detail.rb +205 -0
  1315. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +456 -0
  1316. data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_body.rb +265 -0
  1317. data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_info.rb +265 -0
  1318. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +456 -0
  1319. data/lib/purecloudplatformclientv2/models/email_conversation_notification_uri_reference.rb +187 -0
  1320. data/lib/purecloudplatformclientv2/models/email_conversation_notification_wrapup.rb +225 -0
  1321. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +483 -0
  1322. data/lib/purecloudplatformclientv2/models/email_media_policy.rb +189 -0
  1323. data/lib/purecloudplatformclientv2/models/email_media_policy_conditions.rb +222 -0
  1324. data/lib/purecloudplatformclientv2/models/email_message.rb +308 -0
  1325. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +261 -0
  1326. data/lib/purecloudplatformclientv2/models/email_setup.rb +179 -0
  1327. data/lib/purecloudplatformclientv2/models/empty.rb +169 -0
  1328. data/lib/purecloudplatformclientv2/models/encryption_key.rb +228 -0
  1329. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +261 -0
  1330. data/lib/purecloudplatformclientv2/models/endpoint.rb +363 -0
  1331. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +261 -0
  1332. data/lib/purecloudplatformclientv2/models/entry.rb +189 -0
  1333. data/lib/purecloudplatformclientv2/models/error_body.rb +265 -0
  1334. data/lib/purecloudplatformclientv2/models/error_details.rb +243 -0
  1335. data/lib/purecloudplatformclientv2/models/estimated_wait_time_predictions.rb +185 -0
  1336. data/lib/purecloudplatformclientv2/models/evaluation.rb +387 -0
  1337. data/lib/purecloudplatformclientv2/models/evaluation_assignment.rb +187 -0
  1338. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +261 -0
  1339. data/lib/purecloudplatformclientv2/models/evaluation_form.rb +270 -0
  1340. data/lib/purecloudplatformclientv2/models/evaluation_form_and_scoring_set.rb +187 -0
  1341. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +261 -0
  1342. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +225 -0
  1343. data/lib/purecloudplatformclientv2/models/evaluator_activity.rb +261 -0
  1344. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +261 -0
  1345. data/lib/purecloudplatformclientv2/models/expansion_criterium.rb +201 -0
  1346. data/lib/purecloudplatformclientv2/models/export_uri.rb +188 -0
  1347. data/lib/purecloudplatformclientv2/models/export_uri_notification.rb +196 -0
  1348. data/lib/purecloudplatformclientv2/models/extension.rb +351 -0
  1349. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +261 -0
  1350. data/lib/purecloudplatformclientv2/models/extension_pool.rb +320 -0
  1351. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +261 -0
  1352. data/lib/purecloudplatformclientv2/models/external_contact.rb +366 -0
  1353. data/lib/purecloudplatformclientv2/models/external_data_source.rb +204 -0
  1354. data/lib/purecloudplatformclientv2/models/external_organization.rb +349 -0
  1355. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +261 -0
  1356. data/lib/purecloudplatformclientv2/models/facet_entry.rb +257 -0
  1357. data/lib/purecloudplatformclientv2/models/facet_info.rb +191 -0
  1358. data/lib/purecloudplatformclientv2/models/facet_key_attribute.rb +196 -0
  1359. data/lib/purecloudplatformclientv2/models/facet_statistics.rb +234 -0
  1360. data/lib/purecloudplatformclientv2/models/facet_term.rb +224 -0
  1361. data/lib/purecloudplatformclientv2/models/failed_object.rb +205 -0
  1362. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification.rb +322 -0
  1363. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_data.rb +196 -0
  1364. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_info.rb +196 -0
  1365. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_user_data.rb +187 -0
  1366. data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_workspace_data.rb +178 -0
  1367. data/lib/purecloudplatformclientv2/models/fax_document.rb +337 -0
  1368. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +261 -0
  1369. data/lib/purecloudplatformclientv2/models/fax_send_request.rb +278 -0
  1370. data/lib/purecloudplatformclientv2/models/fax_send_response.rb +230 -0
  1371. data/lib/purecloudplatformclientv2/models/fax_status.rb +249 -0
  1372. data/lib/purecloudplatformclientv2/models/fax_summary.rb +196 -0
  1373. data/lib/purecloudplatformclientv2/models/feature_state.rb +178 -0
  1374. data/lib/purecloudplatformclientv2/models/field_config.rb +259 -0
  1375. data/lib/purecloudplatformclientv2/models/field_configs.rb +205 -0
  1376. data/lib/purecloudplatformclientv2/models/field_list.rb +254 -0
  1377. data/lib/purecloudplatformclientv2/models/flow.rb +336 -0
  1378. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +261 -0
  1379. data/lib/purecloudplatformclientv2/models/flow_version.rb +293 -0
  1380. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +261 -0
  1381. data/lib/purecloudplatformclientv2/models/g_suite.rb +243 -0
  1382. data/lib/purecloudplatformclientv2/models/geolocation.rb +274 -0
  1383. data/lib/purecloudplatformclientv2/models/geolocation_notification.rb +214 -0
  1384. data/lib/purecloudplatformclientv2/models/geolocation_settings.rb +216 -0
  1385. data/lib/purecloudplatformclientv2/models/greeting.rb +324 -0
  1386. data/lib/purecloudplatformclientv2/models/greeting_audio_file.rb +196 -0
  1387. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +261 -0
  1388. data/lib/purecloudplatformclientv2/models/greeting_media_info.rb +197 -0
  1389. data/lib/purecloudplatformclientv2/models/greeting_owner.rb +198 -0
  1390. data/lib/purecloudplatformclientv2/models/group.rb +358 -0
  1391. data/lib/purecloudplatformclientv2/models/group_contact.rb +249 -0
  1392. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +261 -0
  1393. data/lib/purecloudplatformclientv2/models/group_members_update.rb +199 -0
  1394. data/lib/purecloudplatformclientv2/models/group_search_criteria.rb +287 -0
  1395. data/lib/purecloudplatformclientv2/models/group_search_request.rb +234 -0
  1396. data/lib/purecloudplatformclientv2/models/group_update.rb +302 -0
  1397. data/lib/purecloudplatformclientv2/models/groups_search_response.rb +287 -0
  1398. data/lib/purecloudplatformclientv2/models/heart_beat_alert.rb +338 -0
  1399. data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +261 -0
  1400. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb +277 -0
  1401. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_user.rb +187 -0
  1402. data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_users.rb +187 -0
  1403. data/lib/purecloudplatformclientv2/models/heart_beat_rule.rb +315 -0
  1404. data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +261 -0
  1405. data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification.rb +268 -0
  1406. data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification_notification_user.rb +187 -0
  1407. data/lib/purecloudplatformclientv2/models/identity_now.rb +243 -0
  1408. data/lib/purecloudplatformclientv2/models/import_status.rb +249 -0
  1409. data/lib/purecloudplatformclientv2/models/import_status_notification.rb +237 -0
  1410. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +236 -0
  1411. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +261 -0
  1412. data/lib/purecloudplatformclientv2/models/inbound_route.rb +292 -0
  1413. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +261 -0
  1414. data/lib/purecloudplatformclientv2/models/initiate_screen_recording.rb +196 -0
  1415. data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +387 -0
  1416. data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification_notification_user.rb +187 -0
  1417. data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +369 -0
  1418. data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification_notification_user.rb +187 -0
  1419. data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +464 -0
  1420. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +261 -0
  1421. data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +427 -0
  1422. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +261 -0
  1423. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +238 -0
  1424. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_forecast_data_per_interval.rb +196 -0
  1425. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_agent_data_per_interval.rb +187 -0
  1426. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_queue_data_per_interval.rb +241 -0
  1427. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +258 -0
  1428. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +258 -0
  1429. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_forecast_data.rb +196 -0
  1430. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_agent_data.rb +187 -0
  1431. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_queue_data.rb +241 -0
  1432. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +201 -0
  1433. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_agent_data.rb +178 -0
  1434. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_queue_data.rb +196 -0
  1435. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_schedule_data.rb +187 -0
  1436. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +201 -0
  1437. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_agent_data_per_interval.rb +178 -0
  1438. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_queue_data_per_interval.rb +196 -0
  1439. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_schedule_data_per_interval.rb +187 -0
  1440. data/lib/purecloudplatformclientv2/models/json_node.rb +372 -0
  1441. data/lib/purecloudplatformclientv2/models/json_node_search_response.rb +294 -0
  1442. data/lib/purecloudplatformclientv2/models/json_schema_document.rb +237 -0
  1443. data/lib/purecloudplatformclientv2/models/key_rotation_schedule.rb +226 -0
  1444. data/lib/purecloudplatformclientv2/models/keyword.rb +319 -0
  1445. data/lib/purecloudplatformclientv2/models/keyword_set.rb +275 -0
  1446. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +261 -0
  1447. data/lib/purecloudplatformclientv2/models/language.rb +245 -0
  1448. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +261 -0
  1449. data/lib/purecloudplatformclientv2/models/library.rb +231 -0
  1450. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +261 -0
  1451. data/lib/purecloudplatformclientv2/models/license_assignment_request.rb +215 -0
  1452. data/lib/purecloudplatformclientv2/models/license_batch_assignment_request.rb +185 -0
  1453. data/lib/purecloudplatformclientv2/models/license_definition.rb +218 -0
  1454. data/lib/purecloudplatformclientv2/models/license_definition_listing.rb +261 -0
  1455. data/lib/purecloudplatformclientv2/models/license_organization.rb +209 -0
  1456. data/lib/purecloudplatformclientv2/models/license_update_response.rb +180 -0
  1457. data/lib/purecloudplatformclientv2/models/license_update_status.rb +196 -0
  1458. data/lib/purecloudplatformclientv2/models/license_user.rb +200 -0
  1459. data/lib/purecloudplatformclientv2/models/line.rb +385 -0
  1460. data/lib/purecloudplatformclientv2/models/line_base.rb +320 -0
  1461. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +261 -0
  1462. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +261 -0
  1463. data/lib/purecloudplatformclientv2/models/line_status.rb +221 -0
  1464. data/lib/purecloudplatformclientv2/models/local_encryption_configuration.rb +240 -0
  1465. data/lib/purecloudplatformclientv2/models/local_encryption_configuration_listing.rb +198 -0
  1466. data/lib/purecloudplatformclientv2/models/local_encryption_key_request.rb +211 -0
  1467. data/lib/purecloudplatformclientv2/models/location.rb +216 -0
  1468. data/lib/purecloudplatformclientv2/models/location_address.rb +232 -0
  1469. data/lib/purecloudplatformclientv2/models/location_definition.rb +269 -0
  1470. data/lib/purecloudplatformclientv2/models/location_emergency_number.rb +211 -0
  1471. data/lib/purecloudplatformclientv2/models/location_search_criteria.rb +287 -0
  1472. data/lib/purecloudplatformclientv2/models/location_search_request.rb +234 -0
  1473. data/lib/purecloudplatformclientv2/models/locations_search_response.rb +287 -0
  1474. data/lib/purecloudplatformclientv2/models/lock_info.rb +221 -0
  1475. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +261 -0
  1476. data/lib/purecloudplatformclientv2/models/management_unit.rb +247 -0
  1477. data/lib/purecloudplatformclientv2/models/max_participants.rb +179 -0
  1478. data/lib/purecloudplatformclientv2/models/media_participant_request.rb +253 -0
  1479. data/lib/purecloudplatformclientv2/models/media_policies.rb +199 -0
  1480. data/lib/purecloudplatformclientv2/models/media_result.rb +189 -0
  1481. data/lib/purecloudplatformclientv2/models/media_setting.rb +187 -0
  1482. data/lib/purecloudplatformclientv2/models/media_summary.rb +187 -0
  1483. data/lib/purecloudplatformclientv2/models/media_summary_detail.rb +187 -0
  1484. data/lib/purecloudplatformclientv2/models/member_entity.rb +178 -0
  1485. data/lib/purecloudplatformclientv2/models/meta_data.rb +198 -0
  1486. data/lib/purecloudplatformclientv2/models/metabase.rb +300 -0
  1487. data/lib/purecloudplatformclientv2/models/metered_evaluation_assignment.rb +225 -0
  1488. data/lib/purecloudplatformclientv2/models/note.rb +253 -0
  1489. data/lib/purecloudplatformclientv2/models/note_listing.rb +261 -0
  1490. data/lib/purecloudplatformclientv2/models/number.rb +187 -0
  1491. data/lib/purecloudplatformclientv2/models/number_plan.rb +365 -0
  1492. data/lib/purecloudplatformclientv2/models/numeric_range.rb +209 -0
  1493. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +284 -0
  1494. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +261 -0
  1495. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +256 -0
  1496. data/lib/purecloudplatformclientv2/models/o_auth_provider.rb +207 -0
  1497. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +261 -0
  1498. data/lib/purecloudplatformclientv2/models/observation_data_container.rb +192 -0
  1499. data/lib/purecloudplatformclientv2/models/observation_query.rb +195 -0
  1500. data/lib/purecloudplatformclientv2/models/observation_query_response.rb +180 -0
  1501. data/lib/purecloudplatformclientv2/models/okta.rb +234 -0
  1502. data/lib/purecloudplatformclientv2/models/one_login.rb +234 -0
  1503. data/lib/purecloudplatformclientv2/models/operation.rb +284 -0
  1504. data/lib/purecloudplatformclientv2/models/org_media_utilization.rb +201 -0
  1505. data/lib/purecloudplatformclientv2/models/organization.rb +314 -0
  1506. data/lib/purecloudplatformclientv2/models/organization_features.rb +286 -0
  1507. data/lib/purecloudplatformclientv2/models/organization_presence.rb +279 -0
  1508. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +261 -0
  1509. data/lib/purecloudplatformclientv2/models/organization_product_entity_listing.rb +216 -0
  1510. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +261 -0
  1511. data/lib/purecloudplatformclientv2/models/orphan_recording.rb +338 -0
  1512. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +261 -0
  1513. data/lib/purecloudplatformclientv2/models/orphan_update_request.rb +199 -0
  1514. data/lib/purecloudplatformclientv2/models/out_of_office.rb +236 -0
  1515. data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +214 -0
  1516. data/lib/purecloudplatformclientv2/models/out_of_office_notification_user.rb +178 -0
  1517. data/lib/purecloudplatformclientv2/models/outbound_route.rb +380 -0
  1518. data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +360 -0
  1519. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +261 -0
  1520. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +261 -0
  1521. data/lib/purecloudplatformclientv2/models/page.rb +249 -0
  1522. data/lib/purecloudplatformclientv2/models/paging_spec.rb +197 -0
  1523. data/lib/purecloudplatformclientv2/models/parameter.rb +233 -0
  1524. data/lib/purecloudplatformclientv2/models/parsed_certificate.rb +182 -0
  1525. data/lib/purecloudplatformclientv2/models/participant.rb +554 -0
  1526. data/lib/purecloudplatformclientv2/models/participant_attributes.rb +181 -0
  1527. data/lib/purecloudplatformclientv2/models/participant_basic.rb +554 -0
  1528. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +261 -0
  1529. data/lib/purecloudplatformclientv2/models/permissions.rb +204 -0
  1530. data/lib/purecloudplatformclientv2/models/phone.rb +440 -0
  1531. data/lib/purecloudplatformclientv2/models/phone_base.rb +350 -0
  1532. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +261 -0
  1533. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +223 -0
  1534. data/lib/purecloudplatformclientv2/models/phone_column.rb +197 -0
  1535. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +261 -0
  1536. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +261 -0
  1537. data/lib/purecloudplatformclientv2/models/phone_number.rb +223 -0
  1538. data/lib/purecloudplatformclientv2/models/phone_number_column.rb +187 -0
  1539. data/lib/purecloudplatformclientv2/models/phone_number_status.rb +179 -0
  1540. data/lib/purecloudplatformclientv2/models/phone_status.rb +312 -0
  1541. data/lib/purecloudplatformclientv2/models/phones_reboot.rb +191 -0
  1542. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +261 -0
  1543. data/lib/purecloudplatformclientv2/models/pin_configuration.rb +187 -0
  1544. data/lib/purecloudplatformclientv2/models/ping_identity.rb +243 -0
  1545. data/lib/purecloudplatformclientv2/models/policy.rb +284 -0
  1546. data/lib/purecloudplatformclientv2/models/policy_actions.rb +250 -0
  1547. data/lib/purecloudplatformclientv2/models/policy_conditions.rb +253 -0
  1548. data/lib/purecloudplatformclientv2/models/policy_create.rb +289 -0
  1549. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +261 -0
  1550. data/lib/purecloudplatformclientv2/models/policy_error_message.rb +235 -0
  1551. data/lib/purecloudplatformclientv2/models/policy_errors.rb +180 -0
  1552. data/lib/purecloudplatformclientv2/models/prediction_results.rb +235 -0
  1553. data/lib/purecloudplatformclientv2/models/presence_query_response.rb +192 -0
  1554. data/lib/purecloudplatformclientv2/models/prompt.rb +232 -0
  1555. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +281 -0
  1556. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +286 -0
  1557. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +261 -0
  1558. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +261 -0
  1559. data/lib/purecloudplatformclientv2/models/property_index_request.rb +213 -0
  1560. data/lib/purecloudplatformclientv2/models/provision_info.rb +199 -0
  1561. data/lib/purecloudplatformclientv2/models/pure_cloud.rb +207 -0
  1562. data/lib/purecloudplatformclientv2/models/qualifier_mapping_observation_query_response.rb +192 -0
  1563. data/lib/purecloudplatformclientv2/models/quality_audit.rb +272 -0
  1564. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +261 -0
  1565. data/lib/purecloudplatformclientv2/models/query_facet_info.rb +191 -0
  1566. data/lib/purecloudplatformclientv2/models/query_request.rb +249 -0
  1567. data/lib/purecloudplatformclientv2/models/query_result.rb +207 -0
  1568. data/lib/purecloudplatformclientv2/models/query_results.rb +187 -0
  1569. data/lib/purecloudplatformclientv2/models/question.rb +279 -0
  1570. data/lib/purecloudplatformclientv2/models/question_group.rb +261 -0
  1571. data/lib/purecloudplatformclientv2/models/question_group_score.rb +270 -0
  1572. data/lib/purecloudplatformclientv2/models/question_score.rb +223 -0
  1573. data/lib/purecloudplatformclientv2/models/queue.rb +423 -0
  1574. data/lib/purecloudplatformclientv2/models/queue_email_address.rb +187 -0
  1575. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +261 -0
  1576. data/lib/purecloudplatformclientv2/models/queue_member.rb +243 -0
  1577. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +261 -0
  1578. data/lib/purecloudplatformclientv2/models/queue_member_notification.rb +205 -0
  1579. data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +259 -0
  1580. data/lib/purecloudplatformclientv2/models/reaction.rb +210 -0
  1581. data/lib/purecloudplatformclientv2/models/recall_entry.rb +187 -0
  1582. data/lib/purecloudplatformclientv2/models/recording.rb +418 -0
  1583. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification.rb +322 -0
  1584. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_conversation_data.rb +178 -0
  1585. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_data.rb +196 -0
  1586. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_info.rb +196 -0
  1587. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_user_data.rb +187 -0
  1588. data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_workspace_data.rb +178 -0
  1589. data/lib/purecloudplatformclientv2/models/recording_email_message.rb +268 -0
  1590. data/lib/purecloudplatformclientv2/models/recording_settings.rb +178 -0
  1591. data/lib/purecloudplatformclientv2/models/relationship.rb +252 -0
  1592. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +261 -0
  1593. data/lib/purecloudplatformclientv2/models/replace_request.rb +196 -0
  1594. data/lib/purecloudplatformclientv2/models/replace_response.rb +237 -0
  1595. data/lib/purecloudplatformclientv2/models/report_meta_data.rb +258 -0
  1596. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +261 -0
  1597. data/lib/purecloudplatformclientv2/models/report_run_entry.rb +285 -0
  1598. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +261 -0
  1599. data/lib/purecloudplatformclientv2/models/report_schedule.rb +340 -0
  1600. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +261 -0
  1601. data/lib/purecloudplatformclientv2/models/resource_condition_node.rb +246 -0
  1602. data/lib/purecloudplatformclientv2/models/resource_condition_value.rb +201 -0
  1603. data/lib/purecloudplatformclientv2/models/resource_permission_policy.rb +272 -0
  1604. data/lib/purecloudplatformclientv2/models/response.rb +307 -0
  1605. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +262 -0
  1606. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +261 -0
  1607. data/lib/purecloudplatformclientv2/models/response_filter.rb +228 -0
  1608. data/lib/purecloudplatformclientv2/models/response_query_request.rb +202 -0
  1609. data/lib/purecloudplatformclientv2/models/response_query_results.rb +184 -0
  1610. data/lib/purecloudplatformclientv2/models/response_set.rb +244 -0
  1611. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +261 -0
  1612. data/lib/purecloudplatformclientv2/models/response_set_notification.rb +234 -0
  1613. data/lib/purecloudplatformclientv2/models/response_set_notification_reaction.rb +219 -0
  1614. data/lib/purecloudplatformclientv2/models/response_set_notification_responses.rb +219 -0
  1615. data/lib/purecloudplatformclientv2/models/response_substitution.rb +204 -0
  1616. data/lib/purecloudplatformclientv2/models/response_text.rb +208 -0
  1617. data/lib/purecloudplatformclientv2/models/rest_error_detail.rb +193 -0
  1618. data/lib/purecloudplatformclientv2/models/retention_duration.rb +187 -0
  1619. data/lib/purecloudplatformclientv2/models/reverse_whitepages_lookup_result.rb +191 -0
  1620. data/lib/purecloudplatformclientv2/models/ring.rb +189 -0
  1621. data/lib/purecloudplatformclientv2/models/routing_data.rb +227 -0
  1622. data/lib/purecloudplatformclientv2/models/routing_skill.rb +247 -0
  1623. data/lib/purecloudplatformclientv2/models/routing_status.rb +213 -0
  1624. data/lib/purecloudplatformclientv2/models/routing_status_alert.rb +329 -0
  1625. data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +261 -0
  1626. data/lib/purecloudplatformclientv2/models/routing_status_rule.rb +315 -0
  1627. data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +261 -0
  1628. data/lib/purecloudplatformclientv2/models/rule_set.rb +264 -0
  1629. data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +191 -0
  1630. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +261 -0
  1631. data/lib/purecloudplatformclientv2/models/rule_set_notification.rb +252 -0
  1632. data/lib/purecloudplatformclientv2/models/rule_set_notification_action.rb +216 -0
  1633. data/lib/purecloudplatformclientv2/models/rule_set_notification_actions.rb +216 -0
  1634. data/lib/purecloudplatformclientv2/models/rule_set_notification_condition.rb +271 -0
  1635. data/lib/purecloudplatformclientv2/models/rule_set_notification_conditions.rb +271 -0
  1636. data/lib/purecloudplatformclientv2/models/rule_set_notification_rule.rb +250 -0
  1637. data/lib/purecloudplatformclientv2/models/rule_set_notification_rules.rb +250 -0
  1638. data/lib/purecloudplatformclientv2/models/rule_set_notification_uri_reference.rb +187 -0
  1639. data/lib/purecloudplatformclientv2/models/run_now_response.rb +198 -0
  1640. data/lib/purecloudplatformclientv2/models/salesforce.rb +234 -0
  1641. data/lib/purecloudplatformclientv2/models/schedule_interval.rb +189 -0
  1642. data/lib/purecloudplatformclientv2/models/schema_category.rb +300 -0
  1643. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +261 -0
  1644. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +261 -0
  1645. data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +236 -0
  1646. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +261 -0
  1647. data/lib/purecloudplatformclientv2/models/screen_recording_session_request.rb +213 -0
  1648. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification.rb +209 -0
  1649. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_detail.rb +205 -0
  1650. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_body.rb +265 -0
  1651. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_info.rb +265 -0
  1652. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +465 -0
  1653. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +465 -0
  1654. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_uri_reference.rb +187 -0
  1655. data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_wrapup.rb +225 -0
  1656. data/lib/purecloudplatformclientv2/models/screenshare.rb +299 -0
  1657. data/lib/purecloudplatformclientv2/models/script.rb +303 -0
  1658. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +261 -0
  1659. data/lib/purecloudplatformclientv2/models/search_aggregation.rb +245 -0
  1660. data/lib/purecloudplatformclientv2/models/search_criteria.rb +282 -0
  1661. data/lib/purecloudplatformclientv2/models/search_request.rb +287 -0
  1662. data/lib/purecloudplatformclientv2/models/section.rb +207 -0
  1663. data/lib/purecloudplatformclientv2/models/security_profile.rb +209 -0
  1664. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +261 -0
  1665. data/lib/purecloudplatformclientv2/models/segment.rb +227 -0
  1666. data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +272 -0
  1667. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification.rb +252 -0
  1668. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_schedule_interval.rb +196 -0
  1669. data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_uri_reference.rb +187 -0
  1670. data/lib/purecloudplatformclientv2/models/server_date.rb +179 -0
  1671. data/lib/purecloudplatformclientv2/models/service_context.rb +179 -0
  1672. data/lib/purecloudplatformclientv2/models/service_level.rb +187 -0
  1673. data/lib/purecloudplatformclientv2/models/share.rb +298 -0
  1674. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +261 -0
  1675. data/lib/purecloudplatformclientv2/models/shared_entity.rb +178 -0
  1676. data/lib/purecloudplatformclientv2/models/shared_response.rb +214 -0
  1677. data/lib/purecloudplatformclientv2/models/site.rb +399 -0
  1678. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +261 -0
  1679. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +261 -0
  1680. data/lib/purecloudplatformclientv2/models/skills_to_remove.rb +196 -0
  1681. data/lib/purecloudplatformclientv2/models/social_conversation_notification.rb +209 -0
  1682. data/lib/purecloudplatformclientv2/models/social_conversation_notification_detail.rb +205 -0
  1683. data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_body.rb +265 -0
  1684. data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_info.rb +265 -0
  1685. data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +474 -0
  1686. data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +474 -0
  1687. data/lib/purecloudplatformclientv2/models/social_conversation_notification_uri_reference.rb +187 -0
  1688. data/lib/purecloudplatformclientv2/models/social_conversation_notification_wrapup.rb +225 -0
  1689. data/lib/purecloudplatformclientv2/models/social_expression.rb +339 -0
  1690. data/lib/purecloudplatformclientv2/models/sort_item.rb +187 -0
  1691. data/lib/purecloudplatformclientv2/models/station.rb +275 -0
  1692. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +261 -0
  1693. data/lib/purecloudplatformclientv2/models/statistical_response.rb +200 -0
  1694. data/lib/purecloudplatformclientv2/models/statistical_summary.rb +250 -0
  1695. data/lib/purecloudplatformclientv2/models/street_address.rb +256 -0
  1696. data/lib/purecloudplatformclientv2/models/subscriber_response.rb +195 -0
  1697. data/lib/purecloudplatformclientv2/models/suggest_search_criteria.rb +259 -0
  1698. data/lib/purecloudplatformclientv2/models/suggest_search_request.rb +213 -0
  1699. data/lib/purecloudplatformclientv2/models/system_presence.rb +198 -0
  1700. data/lib/purecloudplatformclientv2/models/system_prompt.rb +218 -0
  1701. data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +309 -0
  1702. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +261 -0
  1703. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +261 -0
  1704. data/lib/purecloudplatformclientv2/models/tag_query_request.rb +196 -0
  1705. data/lib/purecloudplatformclientv2/models/tag_value.rb +223 -0
  1706. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +261 -0
  1707. data/lib/purecloudplatformclientv2/models/term_attribute.rb +210 -0
  1708. data/lib/purecloudplatformclientv2/models/ticker.rb +197 -0
  1709. data/lib/purecloudplatformclientv2/models/time_allowed.rb +198 -0
  1710. data/lib/purecloudplatformclientv2/models/time_interval.rb +187 -0
  1711. data/lib/purecloudplatformclientv2/models/time_off_request.rb +390 -0
  1712. data/lib/purecloudplatformclientv2/models/time_off_request_list.rb +209 -0
  1713. data/lib/purecloudplatformclientv2/models/time_off_request_patch.rb +178 -0
  1714. data/lib/purecloudplatformclientv2/models/time_off_request_update_notification.rb +331 -0
  1715. data/lib/purecloudplatformclientv2/models/time_off_request_update_notification_user.rb +178 -0
  1716. data/lib/purecloudplatformclientv2/models/time_slot.rb +199 -0
  1717. data/lib/purecloudplatformclientv2/models/time_zone.rb +207 -0
  1718. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +261 -0
  1719. data/lib/purecloudplatformclientv2/models/transfer_request.rb +219 -0
  1720. data/lib/purecloudplatformclientv2/models/trunk.rb +384 -0
  1721. data/lib/purecloudplatformclientv2/models/trunk_base.rb +363 -0
  1722. data/lib/purecloudplatformclientv2/models/trunk_base_assignment.rb +189 -0
  1723. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +261 -0
  1724. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +261 -0
  1725. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +261 -0
  1726. data/lib/purecloudplatformclientv2/models/trunk_recording_enabled_count.rb +189 -0
  1727. data/lib/purecloudplatformclientv2/models/twitter_id.rb +220 -0
  1728. data/lib/purecloudplatformclientv2/models/unread_metric.rb +179 -0
  1729. data/lib/purecloudplatformclientv2/models/unread_status.rb +179 -0
  1730. data/lib/purecloudplatformclientv2/models/uri_reference.rb +196 -0
  1731. data/lib/purecloudplatformclientv2/models/usage.rb +180 -0
  1732. data/lib/purecloudplatformclientv2/models/usage_item.rb +210 -0
  1733. data/lib/purecloudplatformclientv2/models/user.rb +431 -0
  1734. data/lib/purecloudplatformclientv2/models/user_agent_info.rb +199 -0
  1735. data/lib/purecloudplatformclientv2/models/user_authorization.rb +204 -0
  1736. data/lib/purecloudplatformclientv2/models/user_conversation_summary.rb +232 -0
  1737. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +232 -0
  1738. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call.rb +187 -0
  1739. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call_contact_center.rb +187 -0
  1740. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary.rb +187 -0
  1741. data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary_detail.rb +187 -0
  1742. data/lib/purecloudplatformclientv2/models/user_details_query.rb +273 -0
  1743. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +261 -0
  1744. data/lib/purecloudplatformclientv2/models/user_image.rb +188 -0
  1745. data/lib/purecloudplatformclientv2/models/user_list_schedule_request_body.rb +214 -0
  1746. data/lib/purecloudplatformclientv2/models/user_me.rb +565 -0
  1747. data/lib/purecloudplatformclientv2/models/user_param.rb +187 -0
  1748. data/lib/purecloudplatformclientv2/models/user_presence.rb +246 -0
  1749. data/lib/purecloudplatformclientv2/models/user_presence_alert.rb +352 -0
  1750. data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +261 -0
  1751. data/lib/purecloudplatformclientv2/models/user_presence_notification.rb +205 -0
  1752. data/lib/purecloudplatformclientv2/models/user_presence_notification_organization_presence.rb +187 -0
  1753. data/lib/purecloudplatformclientv2/models/user_presence_notification_presence_definition.rb +187 -0
  1754. data/lib/purecloudplatformclientv2/models/user_presence_rule.rb +329 -0
  1755. data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +261 -0
  1756. data/lib/purecloudplatformclientv2/models/user_queue.rb +432 -0
  1757. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +261 -0
  1758. data/lib/purecloudplatformclientv2/models/user_recording.rb +292 -0
  1759. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +261 -0
  1760. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +243 -0
  1761. data/lib/purecloudplatformclientv2/models/user_routing_skill_post.rb +218 -0
  1762. data/lib/purecloudplatformclientv2/models/user_routing_status_notification.rb +178 -0
  1763. data/lib/purecloudplatformclientv2/models/user_routing_status_notification_routing_status.rb +201 -0
  1764. data/lib/purecloudplatformclientv2/models/user_schedule.rb +194 -0
  1765. data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +230 -0
  1766. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +392 -0
  1767. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +273 -0
  1768. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_user.rb +178 -0
  1769. data/lib/purecloudplatformclientv2/models/user_schedule_container.rb +192 -0
  1770. data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +220 -0
  1771. data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +202 -0
  1772. data/lib/purecloudplatformclientv2/models/user_search_criteria.rb +287 -0
  1773. data/lib/purecloudplatformclientv2/models/user_search_request.rb +246 -0
  1774. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +261 -0
  1775. data/lib/purecloudplatformclientv2/models/user_station.rb +237 -0
  1776. data/lib/purecloudplatformclientv2/models/user_stations.rb +209 -0
  1777. data/lib/purecloudplatformclientv2/models/user_stations_notification.rb +178 -0
  1778. data/lib/purecloudplatformclientv2/models/user_stations_notification_associated_station.rb +196 -0
  1779. data/lib/purecloudplatformclientv2/models/user_stations_notification_user.rb +178 -0
  1780. data/lib/purecloudplatformclientv2/models/user_stations_notification_user_station.rb +196 -0
  1781. data/lib/purecloudplatformclientv2/models/users_search_response.rb +287 -0
  1782. data/lib/purecloudplatformclientv2/models/utilization.rb +181 -0
  1783. data/lib/purecloudplatformclientv2/models/validate_address_request.rb +179 -0
  1784. data/lib/purecloudplatformclientv2/models/validate_address_response.rb +193 -0
  1785. data/lib/purecloudplatformclientv2/models/video.rb +307 -0
  1786. data/lib/purecloudplatformclientv2/models/video_conversation_notification.rb +209 -0
  1787. data/lib/purecloudplatformclientv2/models/video_conversation_notification_detail.rb +205 -0
  1788. data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_body.rb +265 -0
  1789. data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_info.rb +265 -0
  1790. data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +483 -0
  1791. data/lib/purecloudplatformclientv2/models/video_conversation_notification_uri_reference.rb +187 -0
  1792. data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +483 -0
  1793. data/lib/purecloudplatformclientv2/models/video_conversation_notification_wrapup.rb +225 -0
  1794. data/lib/purecloudplatformclientv2/models/visibility_condition.rb +204 -0
  1795. data/lib/purecloudplatformclientv2/models/vm_pairing_info.rb +206 -0
  1796. data/lib/purecloudplatformclientv2/models/voicemail_copy_record.rb +199 -0
  1797. data/lib/purecloudplatformclientv2/models/voicemail_group_policy.rb +228 -0
  1798. data/lib/purecloudplatformclientv2/models/voicemail_mailbox_info.rb +229 -0
  1799. data/lib/purecloudplatformclientv2/models/voicemail_media_info.rb +197 -0
  1800. data/lib/purecloudplatformclientv2/models/voicemail_message.rb +341 -0
  1801. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +261 -0
  1802. data/lib/purecloudplatformclientv2/models/voicemail_message_notification.rb +277 -0
  1803. data/lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb +239 -0
  1804. data/lib/purecloudplatformclientv2/models/voicemail_search_criteria.rb +287 -0
  1805. data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +246 -0
  1806. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +209 -0
  1807. data/lib/purecloudplatformclientv2/models/voicemails_search_response.rb +287 -0
  1808. data/lib/purecloudplatformclientv2/models/wfm_user_entity_listing.rb +180 -0
  1809. data/lib/purecloudplatformclientv2/models/workspace.rb +302 -0
  1810. data/lib/purecloudplatformclientv2/models/workspace_create.rb +201 -0
  1811. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +261 -0
  1812. data/lib/purecloudplatformclientv2/models/workspace_member.rb +271 -0
  1813. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +261 -0
  1814. data/lib/purecloudplatformclientv2/models/workspace_summary.rb +187 -0
  1815. data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping.rb +252 -0
  1816. data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping_notification.rb +236 -0
  1817. data/lib/purecloudplatformclientv2/models/wrapup.rb +241 -0
  1818. data/lib/purecloudplatformclientv2/models/wrapup_code.rb +241 -0
  1819. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +261 -0
  1820. data/lib/purecloudplatformclientv2/version.rb +19 -0
  1821. data/purecloudplatformclientv2.gemspec +32 -0
  1822. data/spec/api_client_spec.rb +273 -0
  1823. data/spec/configuration_spec.rb +25 -0
  1824. data/spec/spec_helper.rb +99 -0
  1825. metadata +2050 -0
@@ -0,0 +1,2557 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@inin.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: ININ
11
+ http://www.inin.com
12
+
13
+ Terms of Service: https://developer.mypurecloud.com/tos
14
+
15
+ =end
16
+
17
+ require "uri"
18
+
19
+ module PureCloud
20
+ class UsersApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+
27
+ # Delete user
28
+ #
29
+ # @param user_id User ID
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [Empty]
32
+ def delete_user(user_id, opts = {})
33
+ data, _status_code, _headers = delete_user_with_http_info(user_id, opts)
34
+ return data
35
+ end
36
+
37
+ # Delete user
38
+ #
39
+ # @param user_id User ID
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
42
+ def delete_user_with_http_info(user_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user ..."
45
+ end
46
+ # verify the required parameter 'user_id' is set
47
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user" if user_id.nil?
48
+ # resource path
49
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
50
+
51
+ # query parameters
52
+ query_params = {}
53
+
54
+ # header parameters
55
+ header_params = {}
56
+
57
+ # HTTP header 'Accept' (if needed)
58
+ local_header_accept = ['application/json']
59
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
60
+
61
+ # HTTP header 'Content-Type'
62
+ local_header_content_type = ['application/json']
63
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
64
+
65
+ # form parameters
66
+ form_params = {}
67
+
68
+ # http body (model)
69
+ post_body = nil
70
+ auth_names = ['PureCloud Auth']
71
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
72
+ :header_params => header_params,
73
+ :query_params => query_params,
74
+ :form_params => form_params,
75
+ :body => post_body,
76
+ :auth_names => auth_names,
77
+ :return_type => 'Empty')
78
+ if @api_client.config.debugging
79
+ @api_client.config.logger.debug "API called: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
+ end
81
+ return data, status_code, headers
82
+ end
83
+
84
+ # Removes all the roles from the user.
85
+ #
86
+ # @param user_id User ID
87
+ # @param [Hash] opts the optional parameters
88
+ # @return [nil]
89
+ def delete_user_roles(user_id, opts = {})
90
+ delete_user_roles_with_http_info(user_id, opts)
91
+ return nil
92
+ end
93
+
94
+ # Removes all the roles from the user.
95
+ #
96
+ # @param user_id User ID
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
99
+ def delete_user_roles_with_http_info(user_id, opts = {})
100
+ if @api_client.config.debugging
101
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_roles ..."
102
+ end
103
+ # verify the required parameter 'user_id' is set
104
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_roles" if user_id.nil?
105
+ # resource path
106
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
107
+
108
+ # query parameters
109
+ query_params = {}
110
+
111
+ # header parameters
112
+ header_params = {}
113
+
114
+ # HTTP header 'Accept' (if needed)
115
+ local_header_accept = ['application/json']
116
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
117
+
118
+ # HTTP header 'Content-Type'
119
+ local_header_content_type = ['application/json']
120
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
121
+
122
+ # form parameters
123
+ form_params = {}
124
+
125
+ # http body (model)
126
+ post_body = nil
127
+ auth_names = ['PureCloud Auth']
128
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
129
+ :header_params => header_params,
130
+ :query_params => query_params,
131
+ :form_params => form_params,
132
+ :body => post_body,
133
+ :auth_names => auth_names)
134
+ if @api_client.config.debugging
135
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ end
137
+ return data, status_code, headers
138
+ end
139
+
140
+ # Remove routing skill from user
141
+ #
142
+ # @param user_id User ID
143
+ # @param skill_id skillId
144
+ # @param [Hash] opts the optional parameters
145
+ # @return [String]
146
+ def delete_user_routingskill(user_id, skill_id, opts = {})
147
+ data, _status_code, _headers = delete_user_routingskill_with_http_info(user_id, skill_id, opts)
148
+ return data
149
+ end
150
+
151
+ # Remove routing skill from user
152
+ #
153
+ # @param user_id User ID
154
+ # @param skill_id skillId
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
157
+ def delete_user_routingskill_with_http_info(user_id, skill_id, opts = {})
158
+ if @api_client.config.debugging
159
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_routingskill ..."
160
+ end
161
+ # verify the required parameter 'user_id' is set
162
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_routingskill" if user_id.nil?
163
+ # verify the required parameter 'skill_id' is set
164
+ fail ArgumentError, "Missing the required parameter 'skill_id' when calling UsersApi.delete_user_routingskill" if skill_id.nil?
165
+ # resource path
166
+ local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)
167
+
168
+ # query parameters
169
+ query_params = {}
170
+
171
+ # header parameters
172
+ header_params = {}
173
+
174
+ # HTTP header 'Accept' (if needed)
175
+ local_header_accept = ['application/json']
176
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
177
+
178
+ # HTTP header 'Content-Type'
179
+ local_header_content_type = ['application/json']
180
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
181
+
182
+ # form parameters
183
+ form_params = {}
184
+
185
+ # http body (model)
186
+ post_body = nil
187
+ auth_names = ['PureCloud Auth']
188
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
189
+ :header_params => header_params,
190
+ :query_params => query_params,
191
+ :form_params => form_params,
192
+ :body => post_body,
193
+ :auth_names => auth_names,
194
+ :return_type => 'String')
195
+ if @api_client.config.debugging
196
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
197
+ end
198
+ return data, status_code, headers
199
+ end
200
+
201
+ # Clear associated station
202
+ #
203
+ # @param user_id User ID
204
+ # @param [Hash] opts the optional parameters
205
+ # @return [nil]
206
+ def delete_user_station_associatedstation(user_id, opts = {})
207
+ delete_user_station_associatedstation_with_http_info(user_id, opts)
208
+ return nil
209
+ end
210
+
211
+ # Clear associated station
212
+ #
213
+ # @param user_id User ID
214
+ # @param [Hash] opts the optional parameters
215
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
216
+ def delete_user_station_associatedstation_with_http_info(user_id, opts = {})
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_station_associatedstation ..."
219
+ end
220
+ # verify the required parameter 'user_id' is set
221
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_station_associatedstation" if user_id.nil?
222
+ # resource path
223
+ local_var_path = "/api/v2/users/{userId}/station/associatedstation".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
224
+
225
+ # query parameters
226
+ query_params = {}
227
+
228
+ # header parameters
229
+ header_params = {}
230
+
231
+ # HTTP header 'Accept' (if needed)
232
+ local_header_accept = ['application/json']
233
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
234
+
235
+ # HTTP header 'Content-Type'
236
+ local_header_content_type = ['application/json']
237
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
238
+
239
+ # form parameters
240
+ form_params = {}
241
+
242
+ # http body (model)
243
+ post_body = nil
244
+ auth_names = ['PureCloud Auth']
245
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
246
+ :header_params => header_params,
247
+ :query_params => query_params,
248
+ :form_params => form_params,
249
+ :body => post_body,
250
+ :auth_names => auth_names)
251
+ if @api_client.config.debugging
252
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_station_associatedstation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
253
+ end
254
+ return data, status_code, headers
255
+ end
256
+
257
+ # Clear default station
258
+ #
259
+ # @param user_id User ID
260
+ # @param [Hash] opts the optional parameters
261
+ # @return [nil]
262
+ def delete_user_station_defaultstation(user_id, opts = {})
263
+ delete_user_station_defaultstation_with_http_info(user_id, opts)
264
+ return nil
265
+ end
266
+
267
+ # Clear default station
268
+ #
269
+ # @param user_id User ID
270
+ # @param [Hash] opts the optional parameters
271
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
272
+ def delete_user_station_defaultstation_with_http_info(user_id, opts = {})
273
+ if @api_client.config.debugging
274
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_station_defaultstation ..."
275
+ end
276
+ # verify the required parameter 'user_id' is set
277
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_station_defaultstation" if user_id.nil?
278
+ # resource path
279
+ local_var_path = "/api/v2/users/{userId}/station/defaultstation".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
280
+
281
+ # query parameters
282
+ query_params = {}
283
+
284
+ # header parameters
285
+ header_params = {}
286
+
287
+ # HTTP header 'Accept' (if needed)
288
+ local_header_accept = ['application/json']
289
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
290
+
291
+ # HTTP header 'Content-Type'
292
+ local_header_content_type = ['application/json']
293
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
294
+
295
+ # form parameters
296
+ form_params = {}
297
+
298
+ # http body (model)
299
+ post_body = nil
300
+ auth_names = ['PureCloud Auth']
301
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
302
+ :header_params => header_params,
303
+ :query_params => query_params,
304
+ :form_params => form_params,
305
+ :body => post_body,
306
+ :auth_names => auth_names)
307
+ if @api_client.config.debugging
308
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_station_defaultstation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
309
+ end
310
+ return data, status_code, headers
311
+ end
312
+
313
+ # Fetch field config for an entity type
314
+ #
315
+ # @param type Field type
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [FieldConfig]
318
+ def get_fieldconfig(type, opts = {})
319
+ data, _status_code, _headers = get_fieldconfig_with_http_info(type, opts)
320
+ return data
321
+ end
322
+
323
+ # Fetch field config for an entity type
324
+ #
325
+ # @param type Field type
326
+ # @param [Hash] opts the optional parameters
327
+ # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
328
+ def get_fieldconfig_with_http_info(type, opts = {})
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug "Calling API: UsersApi.get_fieldconfig ..."
331
+ end
332
+ # verify the required parameter 'type' is set
333
+ fail ArgumentError, "Missing the required parameter 'type' when calling UsersApi.get_fieldconfig" if type.nil?
334
+ # verify enum value
335
+ unless ['person', 'group', 'org', 'externalContact'].include?(type)
336
+ fail ArgumentError, "invalid value for 'type', must be one of person, group, org, externalContact"
337
+ end
338
+ # resource path
339
+ local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
340
+
341
+ # query parameters
342
+ query_params = {}
343
+ query_params[:'type'] = type
344
+
345
+ # header parameters
346
+ header_params = {}
347
+
348
+ # HTTP header 'Accept' (if needed)
349
+ local_header_accept = ['application/json']
350
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
351
+
352
+ # HTTP header 'Content-Type'
353
+ local_header_content_type = ['application/json']
354
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
355
+
356
+ # form parameters
357
+ form_params = {}
358
+
359
+ # http body (model)
360
+ post_body = nil
361
+ auth_names = ['PureCloud Auth']
362
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
363
+ :header_params => header_params,
364
+ :query_params => query_params,
365
+ :form_params => form_params,
366
+ :body => post_body,
367
+ :auth_names => auth_names,
368
+ :return_type => 'FieldConfig')
369
+ if @api_client.config.debugging
370
+ @api_client.config.logger.debug "API called: UsersApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
371
+ end
372
+ return data, status_code, headers
373
+ end
374
+
375
+ # Get user.
376
+ #
377
+ # @param user_id User ID
378
+ # @param [Hash] opts the optional parameters
379
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
380
+ # @return [User]
381
+ def get_user(user_id, opts = {})
382
+ data, _status_code, _headers = get_user_with_http_info(user_id, opts)
383
+ return data
384
+ end
385
+
386
+ # Get user.
387
+ #
388
+ # @param user_id User ID
389
+ # @param [Hash] opts the optional parameters
390
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
391
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
392
+ def get_user_with_http_info(user_id, opts = {})
393
+ if @api_client.config.debugging
394
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user ..."
395
+ end
396
+ # verify the required parameter 'user_id' is set
397
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user" if user_id.nil?
398
+ # resource path
399
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
400
+
401
+ # query parameters
402
+ query_params = {}
403
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
404
+
405
+ # header parameters
406
+ header_params = {}
407
+
408
+ # HTTP header 'Accept' (if needed)
409
+ local_header_accept = ['application/json']
410
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
411
+
412
+ # HTTP header 'Content-Type'
413
+ local_header_content_type = ['application/json']
414
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
415
+
416
+ # form parameters
417
+ form_params = {}
418
+
419
+ # http body (model)
420
+ post_body = nil
421
+ auth_names = ['PureCloud Auth']
422
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
423
+ :header_params => header_params,
424
+ :query_params => query_params,
425
+ :form_params => form_params,
426
+ :body => post_body,
427
+ :auth_names => auth_names,
428
+ :return_type => 'User')
429
+ if @api_client.config.debugging
430
+ @api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
431
+ end
432
+ return data, status_code, headers
433
+ end
434
+
435
+ # Get adjacents
436
+ #
437
+ # @param user_id User ID
438
+ # @param [Hash] opts the optional parameters
439
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
440
+ # @return [Adjacents]
441
+ def get_user_adjacents(user_id, opts = {})
442
+ data, _status_code, _headers = get_user_adjacents_with_http_info(user_id, opts)
443
+ return data
444
+ end
445
+
446
+ # Get adjacents
447
+ #
448
+ # @param user_id User ID
449
+ # @param [Hash] opts the optional parameters
450
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
451
+ # @return [Array<(Adjacents, Fixnum, Hash)>] Adjacents data, response status code and response headers
452
+ def get_user_adjacents_with_http_info(user_id, opts = {})
453
+ if @api_client.config.debugging
454
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_adjacents ..."
455
+ end
456
+ # verify the required parameter 'user_id' is set
457
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_adjacents" if user_id.nil?
458
+ # resource path
459
+ local_var_path = "/api/v2/users/{userId}/adjacents".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
460
+
461
+ # query parameters
462
+ query_params = {}
463
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
464
+
465
+ # header parameters
466
+ header_params = {}
467
+
468
+ # HTTP header 'Accept' (if needed)
469
+ local_header_accept = ['application/json']
470
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
471
+
472
+ # HTTP header 'Content-Type'
473
+ local_header_content_type = ['application/json']
474
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
475
+
476
+ # form parameters
477
+ form_params = {}
478
+
479
+ # http body (model)
480
+ post_body = nil
481
+ auth_names = ['PureCloud Auth']
482
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
483
+ :header_params => header_params,
484
+ :query_params => query_params,
485
+ :form_params => form_params,
486
+ :body => post_body,
487
+ :auth_names => auth_names,
488
+ :return_type => 'Adjacents')
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug "API called: UsersApi#get_user_adjacents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
491
+ end
492
+ return data, status_code, headers
493
+ end
494
+
495
+ # Get a user's CallForwarding
496
+ #
497
+ # @param user_id User ID
498
+ # @param [Hash] opts the optional parameters
499
+ # @return [CallForwarding]
500
+ def get_user_callforwarding(user_id, opts = {})
501
+ data, _status_code, _headers = get_user_callforwarding_with_http_info(user_id, opts)
502
+ return data
503
+ end
504
+
505
+ # Get a user&#39;s CallForwarding
506
+ #
507
+ # @param user_id User ID
508
+ # @param [Hash] opts the optional parameters
509
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
510
+ def get_user_callforwarding_with_http_info(user_id, opts = {})
511
+ if @api_client.config.debugging
512
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_callforwarding ..."
513
+ end
514
+ # verify the required parameter 'user_id' is set
515
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_callforwarding" if user_id.nil?
516
+ # resource path
517
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
518
+
519
+ # query parameters
520
+ query_params = {}
521
+
522
+ # header parameters
523
+ header_params = {}
524
+
525
+ # HTTP header 'Accept' (if needed)
526
+ local_header_accept = ['application/json']
527
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
528
+
529
+ # HTTP header 'Content-Type'
530
+ local_header_content_type = ['application/json']
531
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
532
+
533
+ # form parameters
534
+ form_params = {}
535
+
536
+ # http body (model)
537
+ post_body = nil
538
+ auth_names = ['PureCloud Auth']
539
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
540
+ :header_params => header_params,
541
+ :query_params => query_params,
542
+ :form_params => form_params,
543
+ :body => post_body,
544
+ :auth_names => auth_names,
545
+ :return_type => 'CallForwarding')
546
+ if @api_client.config.debugging
547
+ @api_client.config.logger.debug "API called: UsersApi#get_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
548
+ end
549
+ return data, status_code, headers
550
+ end
551
+
552
+ # Get direct reports
553
+ #
554
+ # @param user_id User ID
555
+ # @param [Hash] opts the optional parameters
556
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
557
+ # @return [Array<User>]
558
+ def get_user_directreports(user_id, opts = {})
559
+ data, _status_code, _headers = get_user_directreports_with_http_info(user_id, opts)
560
+ return data
561
+ end
562
+
563
+ # Get direct reports
564
+ #
565
+ # @param user_id User ID
566
+ # @param [Hash] opts the optional parameters
567
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
568
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
569
+ def get_user_directreports_with_http_info(user_id, opts = {})
570
+ if @api_client.config.debugging
571
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_directreports ..."
572
+ end
573
+ # verify the required parameter 'user_id' is set
574
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_directreports" if user_id.nil?
575
+ # resource path
576
+ local_var_path = "/api/v2/users/{userId}/directreports".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
577
+
578
+ # query parameters
579
+ query_params = {}
580
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
581
+
582
+ # header parameters
583
+ header_params = {}
584
+
585
+ # HTTP header 'Accept' (if needed)
586
+ local_header_accept = ['application/json']
587
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
588
+
589
+ # HTTP header 'Content-Type'
590
+ local_header_content_type = ['application/json']
591
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
592
+
593
+ # form parameters
594
+ form_params = {}
595
+
596
+ # http body (model)
597
+ post_body = nil
598
+ auth_names = ['PureCloud Auth']
599
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
600
+ :header_params => header_params,
601
+ :query_params => query_params,
602
+ :form_params => form_params,
603
+ :body => post_body,
604
+ :auth_names => auth_names,
605
+ :return_type => 'Array<User>')
606
+ if @api_client.config.debugging
607
+ @api_client.config.logger.debug "API called: UsersApi#get_user_directreports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
608
+ end
609
+ return data, status_code, headers
610
+ end
611
+
612
+ # Get favorites
613
+ #
614
+ # @param user_id User ID
615
+ # @param [Hash] opts the optional parameters
616
+ # @option opts [Integer] :page_size Page size (default to 25)
617
+ # @option opts [Integer] :page_number Page number (default to 1)
618
+ # @option opts [String] :sort_order Sort order (default to ASC)
619
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
620
+ # @return [UserEntityListing]
621
+ def get_user_favorites(user_id, opts = {})
622
+ data, _status_code, _headers = get_user_favorites_with_http_info(user_id, opts)
623
+ return data
624
+ end
625
+
626
+ # Get favorites
627
+ #
628
+ # @param user_id User ID
629
+ # @param [Hash] opts the optional parameters
630
+ # @option opts [Integer] :page_size Page size
631
+ # @option opts [Integer] :page_number Page number
632
+ # @option opts [String] :sort_order Sort order
633
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
634
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
635
+ def get_user_favorites_with_http_info(user_id, opts = {})
636
+ if @api_client.config.debugging
637
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_favorites ..."
638
+ end
639
+ # verify the required parameter 'user_id' is set
640
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_favorites" if user_id.nil?
641
+ # resource path
642
+ local_var_path = "/api/v2/users/{userId}/favorites".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
643
+
644
+ # query parameters
645
+ query_params = {}
646
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
647
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
648
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
649
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
650
+
651
+ # header parameters
652
+ header_params = {}
653
+
654
+ # HTTP header 'Accept' (if needed)
655
+ local_header_accept = ['application/json']
656
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
657
+
658
+ # HTTP header 'Content-Type'
659
+ local_header_content_type = ['application/json']
660
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
661
+
662
+ # form parameters
663
+ form_params = {}
664
+
665
+ # http body (model)
666
+ post_body = nil
667
+ auth_names = ['PureCloud Auth']
668
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
669
+ :header_params => header_params,
670
+ :query_params => query_params,
671
+ :form_params => form_params,
672
+ :body => post_body,
673
+ :auth_names => auth_names,
674
+ :return_type => 'UserEntityListing')
675
+ if @api_client.config.debugging
676
+ @api_client.config.logger.debug "API called: UsersApi#get_user_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
677
+ end
678
+ return data, status_code, headers
679
+ end
680
+
681
+ # Get a user's Geolocation
682
+ #
683
+ # @param user_id user Id
684
+ # @param client_id client Id
685
+ # @param [Hash] opts the optional parameters
686
+ # @return [Geolocation]
687
+ def get_user_geolocation(user_id, client_id, opts = {})
688
+ data, _status_code, _headers = get_user_geolocation_with_http_info(user_id, client_id, opts)
689
+ return data
690
+ end
691
+
692
+ # Get a user&#39;s Geolocation
693
+ #
694
+ # @param user_id user Id
695
+ # @param client_id client Id
696
+ # @param [Hash] opts the optional parameters
697
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
698
+ def get_user_geolocation_with_http_info(user_id, client_id, opts = {})
699
+ if @api_client.config.debugging
700
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_geolocation ..."
701
+ end
702
+ # verify the required parameter 'user_id' is set
703
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_geolocation" if user_id.nil?
704
+ # verify the required parameter 'client_id' is set
705
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling UsersApi.get_user_geolocation" if client_id.nil?
706
+ # resource path
707
+ local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
708
+
709
+ # query parameters
710
+ query_params = {}
711
+
712
+ # header parameters
713
+ header_params = {}
714
+
715
+ # HTTP header 'Accept' (if needed)
716
+ local_header_accept = ['application/json']
717
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
718
+
719
+ # HTTP header 'Content-Type'
720
+ local_header_content_type = ['application/json']
721
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
722
+
723
+ # form parameters
724
+ form_params = {}
725
+
726
+ # http body (model)
727
+ post_body = nil
728
+ auth_names = ['PureCloud Auth']
729
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
730
+ :header_params => header_params,
731
+ :query_params => query_params,
732
+ :form_params => form_params,
733
+ :body => post_body,
734
+ :auth_names => auth_names,
735
+ :return_type => 'Geolocation')
736
+ if @api_client.config.debugging
737
+ @api_client.config.logger.debug "API called: UsersApi#get_user_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
738
+ end
739
+ return data, status_code, headers
740
+ end
741
+
742
+ # Get a OutOfOffice
743
+ #
744
+ # @param user_id User ID
745
+ # @param [Hash] opts the optional parameters
746
+ # @return [OutOfOffice]
747
+ def get_user_outofoffice(user_id, opts = {})
748
+ data, _status_code, _headers = get_user_outofoffice_with_http_info(user_id, opts)
749
+ return data
750
+ end
751
+
752
+ # Get a OutOfOffice
753
+ #
754
+ # @param user_id User ID
755
+ # @param [Hash] opts the optional parameters
756
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
757
+ def get_user_outofoffice_with_http_info(user_id, opts = {})
758
+ if @api_client.config.debugging
759
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_outofoffice ..."
760
+ end
761
+ # verify the required parameter 'user_id' is set
762
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_outofoffice" if user_id.nil?
763
+ # resource path
764
+ local_var_path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
765
+
766
+ # query parameters
767
+ query_params = {}
768
+
769
+ # header parameters
770
+ header_params = {}
771
+
772
+ # HTTP header 'Accept' (if needed)
773
+ local_header_accept = ['application/json']
774
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
775
+
776
+ # HTTP header 'Content-Type'
777
+ local_header_content_type = ['application/json']
778
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
779
+
780
+ # form parameters
781
+ form_params = {}
782
+
783
+ # http body (model)
784
+ post_body = nil
785
+ auth_names = ['PureCloud Auth']
786
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
787
+ :header_params => header_params,
788
+ :query_params => query_params,
789
+ :form_params => form_params,
790
+ :body => post_body,
791
+ :auth_names => auth_names,
792
+ :return_type => 'OutOfOffice')
793
+ if @api_client.config.debugging
794
+ @api_client.config.logger.debug "API called: UsersApi#get_user_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
795
+ end
796
+ return data, status_code, headers
797
+ end
798
+
799
+ # List profile skills for a user
800
+ #
801
+ # @param user_id User ID
802
+ # @param [Hash] opts the optional parameters
803
+ # @return [Array<String>]
804
+ def get_user_profileskills(user_id, opts = {})
805
+ data, _status_code, _headers = get_user_profileskills_with_http_info(user_id, opts)
806
+ return data
807
+ end
808
+
809
+ # List profile skills for a user
810
+ #
811
+ # @param user_id User ID
812
+ # @param [Hash] opts the optional parameters
813
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
814
+ def get_user_profileskills_with_http_info(user_id, opts = {})
815
+ if @api_client.config.debugging
816
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_profileskills ..."
817
+ end
818
+ # verify the required parameter 'user_id' is set
819
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profileskills" if user_id.nil?
820
+ # resource path
821
+ local_var_path = "/api/v2/users/{userId}/profileskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
822
+
823
+ # query parameters
824
+ query_params = {}
825
+
826
+ # header parameters
827
+ header_params = {}
828
+
829
+ # HTTP header 'Accept' (if needed)
830
+ local_header_accept = ['application/json']
831
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
832
+
833
+ # HTTP header 'Content-Type'
834
+ local_header_content_type = ['application/json']
835
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
836
+
837
+ # form parameters
838
+ form_params = {}
839
+
840
+ # http body (model)
841
+ post_body = nil
842
+ auth_names = ['PureCloud Auth']
843
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
844
+ :header_params => header_params,
845
+ :query_params => query_params,
846
+ :form_params => form_params,
847
+ :body => post_body,
848
+ :auth_names => auth_names,
849
+ :return_type => 'Array<String>')
850
+ if @api_client.config.debugging
851
+ @api_client.config.logger.debug "API called: UsersApi#get_user_profileskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
852
+ end
853
+ return data, status_code, headers
854
+ end
855
+
856
+ # Get queues for user
857
+ #
858
+ # @param user_id User ID
859
+ # @param [Hash] opts the optional parameters
860
+ # @option opts [Integer] :page_size Page size (default to 25)
861
+ # @option opts [Integer] :page_number Page number (default to 1)
862
+ # @option opts [BOOLEAN] :joined Is joined to the queue (default to true)
863
+ # @return [UserQueueEntityListing]
864
+ def get_user_queues(user_id, opts = {})
865
+ data, _status_code, _headers = get_user_queues_with_http_info(user_id, opts)
866
+ return data
867
+ end
868
+
869
+ # Get queues for user
870
+ #
871
+ # @param user_id User ID
872
+ # @param [Hash] opts the optional parameters
873
+ # @option opts [Integer] :page_size Page size
874
+ # @option opts [Integer] :page_number Page number
875
+ # @option opts [BOOLEAN] :joined Is joined to the queue
876
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
877
+ def get_user_queues_with_http_info(user_id, opts = {})
878
+ if @api_client.config.debugging
879
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_queues ..."
880
+ end
881
+ # verify the required parameter 'user_id' is set
882
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_queues" if user_id.nil?
883
+ # resource path
884
+ local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
885
+
886
+ # query parameters
887
+ query_params = {}
888
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
889
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
890
+ query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
891
+
892
+ # header parameters
893
+ header_params = {}
894
+
895
+ # HTTP header 'Accept' (if needed)
896
+ local_header_accept = ['application/json']
897
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
898
+
899
+ # HTTP header 'Content-Type'
900
+ local_header_content_type = ['application/json']
901
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
902
+
903
+ # form parameters
904
+ form_params = {}
905
+
906
+ # http body (model)
907
+ post_body = nil
908
+ auth_names = ['PureCloud Auth']
909
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
910
+ :header_params => header_params,
911
+ :query_params => query_params,
912
+ :form_params => form_params,
913
+ :body => post_body,
914
+ :auth_names => auth_names,
915
+ :return_type => 'UserQueueEntityListing')
916
+ if @api_client.config.debugging
917
+ @api_client.config.logger.debug "API called: UsersApi#get_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
918
+ end
919
+ return data, status_code, headers
920
+ end
921
+
922
+ # Returns a listing of roles and permissions for a user.
923
+ #
924
+ # @param user_id User ID
925
+ # @param [Hash] opts the optional parameters
926
+ # @return [UserAuthorization]
927
+ def get_user_roles(user_id, opts = {})
928
+ data, _status_code, _headers = get_user_roles_with_http_info(user_id, opts)
929
+ return data
930
+ end
931
+
932
+ # Returns a listing of roles and permissions for a user.
933
+ #
934
+ # @param user_id User ID
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
937
+ def get_user_roles_with_http_info(user_id, opts = {})
938
+ if @api_client.config.debugging
939
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_roles ..."
940
+ end
941
+ # verify the required parameter 'user_id' is set
942
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_roles" if user_id.nil?
943
+ # resource path
944
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
945
+
946
+ # query parameters
947
+ query_params = {}
948
+
949
+ # header parameters
950
+ header_params = {}
951
+
952
+ # HTTP header 'Accept' (if needed)
953
+ local_header_accept = ['application/json']
954
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
955
+
956
+ # HTTP header 'Content-Type'
957
+ local_header_content_type = ['application/json']
958
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
959
+
960
+ # form parameters
961
+ form_params = {}
962
+
963
+ # http body (model)
964
+ post_body = nil
965
+ auth_names = ['PureCloud Auth']
966
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
967
+ :header_params => header_params,
968
+ :query_params => query_params,
969
+ :form_params => form_params,
970
+ :body => post_body,
971
+ :auth_names => auth_names,
972
+ :return_type => 'UserAuthorization')
973
+ if @api_client.config.debugging
974
+ @api_client.config.logger.debug "API called: UsersApi#get_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
975
+ end
976
+ return data, status_code, headers
977
+ end
978
+
979
+ # List routing skills for user
980
+ #
981
+ # @param user_id User ID
982
+ # @param [Hash] opts the optional parameters
983
+ # @option opts [Integer] :page_size Page size (default to 25)
984
+ # @option opts [Integer] :page_number Page number (default to 1)
985
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
986
+ # @return [UserSkillEntityListing]
987
+ def get_user_routingskills(user_id, opts = {})
988
+ data, _status_code, _headers = get_user_routingskills_with_http_info(user_id, opts)
989
+ return data
990
+ end
991
+
992
+ # List routing skills for user
993
+ #
994
+ # @param user_id User ID
995
+ # @param [Hash] opts the optional parameters
996
+ # @option opts [Integer] :page_size Page size
997
+ # @option opts [Integer] :page_number Page number
998
+ # @option opts [String] :sort_order Ascending or descending sort order
999
+ # @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers
1000
+ def get_user_routingskills_with_http_info(user_id, opts = {})
1001
+ if @api_client.config.debugging
1002
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_routingskills ..."
1003
+ end
1004
+ # verify the required parameter 'user_id' is set
1005
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_routingskills" if user_id.nil?
1006
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
1007
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
1008
+ end
1009
+ # resource path
1010
+ local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1011
+
1012
+ # query parameters
1013
+ query_params = {}
1014
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1015
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1016
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1017
+
1018
+ # header parameters
1019
+ header_params = {}
1020
+
1021
+ # HTTP header 'Accept' (if needed)
1022
+ local_header_accept = ['application/json']
1023
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1024
+
1025
+ # HTTP header 'Content-Type'
1026
+ local_header_content_type = ['application/json']
1027
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1028
+
1029
+ # form parameters
1030
+ form_params = {}
1031
+
1032
+ # http body (model)
1033
+ post_body = nil
1034
+ auth_names = ['PureCloud Auth']
1035
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1036
+ :header_params => header_params,
1037
+ :query_params => query_params,
1038
+ :form_params => form_params,
1039
+ :body => post_body,
1040
+ :auth_names => auth_names,
1041
+ :return_type => 'UserSkillEntityListing')
1042
+ if @api_client.config.debugging
1043
+ @api_client.config.logger.debug "API called: UsersApi#get_user_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1044
+ end
1045
+ return data, status_code, headers
1046
+ end
1047
+
1048
+ # Fetch the routing status of a user
1049
+ #
1050
+ # @param user_id User ID
1051
+ # @param [Hash] opts the optional parameters
1052
+ # @return [RoutingStatus]
1053
+ def get_user_routingstatus(user_id, opts = {})
1054
+ data, _status_code, _headers = get_user_routingstatus_with_http_info(user_id, opts)
1055
+ return data
1056
+ end
1057
+
1058
+ # Fetch the routing status of a user
1059
+ #
1060
+ # @param user_id User ID
1061
+ # @param [Hash] opts the optional parameters
1062
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
1063
+ def get_user_routingstatus_with_http_info(user_id, opts = {})
1064
+ if @api_client.config.debugging
1065
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_routingstatus ..."
1066
+ end
1067
+ # verify the required parameter 'user_id' is set
1068
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_routingstatus" if user_id.nil?
1069
+ # resource path
1070
+ local_var_path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1071
+
1072
+ # query parameters
1073
+ query_params = {}
1074
+
1075
+ # header parameters
1076
+ header_params = {}
1077
+
1078
+ # HTTP header 'Accept' (if needed)
1079
+ local_header_accept = ['application/json']
1080
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1081
+
1082
+ # HTTP header 'Content-Type'
1083
+ local_header_content_type = ['application/json']
1084
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1085
+
1086
+ # form parameters
1087
+ form_params = {}
1088
+
1089
+ # http body (model)
1090
+ post_body = nil
1091
+ auth_names = ['PureCloud Auth']
1092
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1093
+ :header_params => header_params,
1094
+ :query_params => query_params,
1095
+ :form_params => form_params,
1096
+ :body => post_body,
1097
+ :auth_names => auth_names,
1098
+ :return_type => 'RoutingStatus')
1099
+ if @api_client.config.debugging
1100
+ @api_client.config.logger.debug "API called: UsersApi#get_user_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1101
+ end
1102
+ return data, status_code, headers
1103
+ end
1104
+
1105
+ # Get station information for user
1106
+ #
1107
+ # @param user_id User ID
1108
+ # @param [Hash] opts the optional parameters
1109
+ # @return [UserStations]
1110
+ def get_user_station(user_id, opts = {})
1111
+ data, _status_code, _headers = get_user_station_with_http_info(user_id, opts)
1112
+ return data
1113
+ end
1114
+
1115
+ # Get station information for user
1116
+ #
1117
+ # @param user_id User ID
1118
+ # @param [Hash] opts the optional parameters
1119
+ # @return [Array<(UserStations, Fixnum, Hash)>] UserStations data, response status code and response headers
1120
+ def get_user_station_with_http_info(user_id, opts = {})
1121
+ if @api_client.config.debugging
1122
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_station ..."
1123
+ end
1124
+ # verify the required parameter 'user_id' is set
1125
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_station" if user_id.nil?
1126
+ # resource path
1127
+ local_var_path = "/api/v2/users/{userId}/station".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1128
+
1129
+ # query parameters
1130
+ query_params = {}
1131
+
1132
+ # header parameters
1133
+ header_params = {}
1134
+
1135
+ # HTTP header 'Accept' (if needed)
1136
+ local_header_accept = ['application/json']
1137
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1138
+
1139
+ # HTTP header 'Content-Type'
1140
+ local_header_content_type = ['application/json']
1141
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1142
+
1143
+ # form parameters
1144
+ form_params = {}
1145
+
1146
+ # http body (model)
1147
+ post_body = nil
1148
+ auth_names = ['PureCloud Auth']
1149
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1150
+ :header_params => header_params,
1151
+ :query_params => query_params,
1152
+ :form_params => form_params,
1153
+ :body => post_body,
1154
+ :auth_names => auth_names,
1155
+ :return_type => 'UserStations')
1156
+ if @api_client.config.debugging
1157
+ @api_client.config.logger.debug "API called: UsersApi#get_user_station\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1158
+ end
1159
+ return data, status_code, headers
1160
+ end
1161
+
1162
+ # Get superiors
1163
+ #
1164
+ # @param user_id User ID
1165
+ # @param [Hash] opts the optional parameters
1166
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1167
+ # @return [Array<User>]
1168
+ def get_user_superiors(user_id, opts = {})
1169
+ data, _status_code, _headers = get_user_superiors_with_http_info(user_id, opts)
1170
+ return data
1171
+ end
1172
+
1173
+ # Get superiors
1174
+ #
1175
+ # @param user_id User ID
1176
+ # @param [Hash] opts the optional parameters
1177
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1178
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
1179
+ def get_user_superiors_with_http_info(user_id, opts = {})
1180
+ if @api_client.config.debugging
1181
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_superiors ..."
1182
+ end
1183
+ # verify the required parameter 'user_id' is set
1184
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_superiors" if user_id.nil?
1185
+ # resource path
1186
+ local_var_path = "/api/v2/users/{userId}/superiors".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1187
+
1188
+ # query parameters
1189
+ query_params = {}
1190
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1191
+
1192
+ # header parameters
1193
+ header_params = {}
1194
+
1195
+ # HTTP header 'Accept' (if needed)
1196
+ local_header_accept = ['application/json']
1197
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1198
+
1199
+ # HTTP header 'Content-Type'
1200
+ local_header_content_type = ['application/json']
1201
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1202
+
1203
+ # form parameters
1204
+ form_params = {}
1205
+
1206
+ # http body (model)
1207
+ post_body = nil
1208
+ auth_names = ['PureCloud Auth']
1209
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1210
+ :header_params => header_params,
1211
+ :query_params => query_params,
1212
+ :form_params => form_params,
1213
+ :body => post_body,
1214
+ :auth_names => auth_names,
1215
+ :return_type => 'Array<User>')
1216
+ if @api_client.config.debugging
1217
+ @api_client.config.logger.debug "API called: UsersApi#get_user_superiors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1218
+ end
1219
+ return data, status_code, headers
1220
+ end
1221
+
1222
+ # Get the list of available users.
1223
+ #
1224
+ # @param [Hash] opts the optional parameters
1225
+ # @option opts [Integer] :page_size Page size (default to 25)
1226
+ # @option opts [Integer] :page_number Page number (default to 1)
1227
+ # @option opts [Array<String>] :id id
1228
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
1229
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1230
+ # @return [UserEntityListing]
1231
+ def get_users(opts = {})
1232
+ data, _status_code, _headers = get_users_with_http_info(opts)
1233
+ return data
1234
+ end
1235
+
1236
+ # Get the list of available users.
1237
+ #
1238
+ # @param [Hash] opts the optional parameters
1239
+ # @option opts [Integer] :page_size Page size
1240
+ # @option opts [Integer] :page_number Page number
1241
+ # @option opts [Array<String>] :id id
1242
+ # @option opts [String] :sort_order Ascending or descending sort order
1243
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1244
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
1245
+ def get_users_with_http_info(opts = {})
1246
+ if @api_client.config.debugging
1247
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
1248
+ end
1249
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
1250
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
1251
+ end
1252
+ # resource path
1253
+ local_var_path = "/api/v2/users".sub('{format}','json')
1254
+
1255
+ # query parameters
1256
+ query_params = {}
1257
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1258
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1259
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1260
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1261
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1262
+
1263
+ # header parameters
1264
+ header_params = {}
1265
+
1266
+ # HTTP header 'Accept' (if needed)
1267
+ local_header_accept = ['application/json']
1268
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1269
+
1270
+ # HTTP header 'Content-Type'
1271
+ local_header_content_type = ['application/json']
1272
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1273
+
1274
+ # form parameters
1275
+ form_params = {}
1276
+
1277
+ # http body (model)
1278
+ post_body = nil
1279
+ auth_names = ['PureCloud Auth']
1280
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1281
+ :header_params => header_params,
1282
+ :query_params => query_params,
1283
+ :form_params => form_params,
1284
+ :body => post_body,
1285
+ :auth_names => auth_names,
1286
+ :return_type => 'UserEntityListing')
1287
+ if @api_client.config.debugging
1288
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1289
+ end
1290
+ return data, status_code, headers
1291
+ end
1292
+
1293
+ # Get current user details.
1294
+ # This request is not valid when using the Client Credentials OAuth grant.
1295
+ # @param [Hash] opts the optional parameters
1296
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
1297
+ # @return [UserMe]
1298
+ def get_users_me(opts = {})
1299
+ data, _status_code, _headers = get_users_me_with_http_info(opts)
1300
+ return data
1301
+ end
1302
+
1303
+ # Get current user details.
1304
+ # This request is not valid when using the Client Credentials OAuth grant.
1305
+ # @param [Hash] opts the optional parameters
1306
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
1307
+ # @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
1308
+ def get_users_me_with_http_info(opts = {})
1309
+ if @api_client.config.debugging
1310
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users_me ..."
1311
+ end
1312
+ # resource path
1313
+ local_var_path = "/api/v2/users/me".sub('{format}','json')
1314
+
1315
+ # query parameters
1316
+ query_params = {}
1317
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1318
+
1319
+ # header parameters
1320
+ header_params = {}
1321
+
1322
+ # HTTP header 'Accept' (if needed)
1323
+ local_header_accept = ['application/json']
1324
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1325
+
1326
+ # HTTP header 'Content-Type'
1327
+ local_header_content_type = ['application/json']
1328
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1329
+
1330
+ # form parameters
1331
+ form_params = {}
1332
+
1333
+ # http body (model)
1334
+ post_body = nil
1335
+ auth_names = ['PureCloud Auth']
1336
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1337
+ :header_params => header_params,
1338
+ :query_params => query_params,
1339
+ :form_params => form_params,
1340
+ :body => post_body,
1341
+ :auth_names => auth_names,
1342
+ :return_type => 'UserMe')
1343
+ if @api_client.config.debugging
1344
+ @api_client.config.logger.debug "API called: UsersApi#get_users_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1345
+ end
1346
+ return data, status_code, headers
1347
+ end
1348
+
1349
+ # Search users using the q64 value returned from a previous search
1350
+ #
1351
+ # @param q64 q64
1352
+ # @param [Hash] opts the optional parameters
1353
+ # @option opts [Array<String>] :expand expand
1354
+ # @return [UsersSearchResponse]
1355
+ def get_users_search(q64, opts = {})
1356
+ data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
1357
+ return data
1358
+ end
1359
+
1360
+ # Search users using the q64 value returned from a previous search
1361
+ #
1362
+ # @param q64 q64
1363
+ # @param [Hash] opts the optional parameters
1364
+ # @option opts [Array<String>] :expand expand
1365
+ # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
1366
+ def get_users_search_with_http_info(q64, opts = {})
1367
+ if @api_client.config.debugging
1368
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users_search ..."
1369
+ end
1370
+ # verify the required parameter 'q64' is set
1371
+ fail ArgumentError, "Missing the required parameter 'q64' when calling UsersApi.get_users_search" if q64.nil?
1372
+ # resource path
1373
+ local_var_path = "/api/v2/users/search".sub('{format}','json')
1374
+
1375
+ # query parameters
1376
+ query_params = {}
1377
+ query_params[:'q64'] = q64
1378
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1379
+
1380
+ # header parameters
1381
+ header_params = {}
1382
+
1383
+ # HTTP header 'Accept' (if needed)
1384
+ local_header_accept = ['application/json']
1385
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1386
+
1387
+ # HTTP header 'Content-Type'
1388
+ local_header_content_type = ['application/json']
1389
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1390
+
1391
+ # form parameters
1392
+ form_params = {}
1393
+
1394
+ # http body (model)
1395
+ post_body = nil
1396
+ auth_names = ['PureCloud Auth']
1397
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1398
+ :header_params => header_params,
1399
+ :query_params => query_params,
1400
+ :form_params => form_params,
1401
+ :body => post_body,
1402
+ :auth_names => auth_names,
1403
+ :return_type => 'UsersSearchResponse')
1404
+ if @api_client.config.debugging
1405
+ @api_client.config.logger.debug "API called: UsersApi#get_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1406
+ end
1407
+ return data, status_code, headers
1408
+ end
1409
+
1410
+ # Update user
1411
+ #
1412
+ # @param user_id User ID
1413
+ # @param body User
1414
+ # @param [Hash] opts the optional parameters
1415
+ # @return [User]
1416
+ def patch_user(user_id, body, opts = {})
1417
+ data, _status_code, _headers = patch_user_with_http_info(user_id, body, opts)
1418
+ return data
1419
+ end
1420
+
1421
+ # Update user
1422
+ #
1423
+ # @param user_id User ID
1424
+ # @param body User
1425
+ # @param [Hash] opts the optional parameters
1426
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
1427
+ def patch_user_with_http_info(user_id, body, opts = {})
1428
+ if @api_client.config.debugging
1429
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user ..."
1430
+ end
1431
+ # verify the required parameter 'user_id' is set
1432
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user" if user_id.nil?
1433
+ # verify the required parameter 'body' is set
1434
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user" if body.nil?
1435
+ # resource path
1436
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1437
+
1438
+ # query parameters
1439
+ query_params = {}
1440
+
1441
+ # header parameters
1442
+ header_params = {}
1443
+
1444
+ # HTTP header 'Accept' (if needed)
1445
+ local_header_accept = ['application/json']
1446
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1447
+
1448
+ # HTTP header 'Content-Type'
1449
+ local_header_content_type = ['application/json']
1450
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1451
+
1452
+ # form parameters
1453
+ form_params = {}
1454
+
1455
+ # http body (model)
1456
+ post_body = @api_client.object_to_http_body(body)
1457
+ auth_names = ['PureCloud Auth']
1458
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1459
+ :header_params => header_params,
1460
+ :query_params => query_params,
1461
+ :form_params => form_params,
1462
+ :body => post_body,
1463
+ :auth_names => auth_names,
1464
+ :return_type => 'User')
1465
+ if @api_client.config.debugging
1466
+ @api_client.config.logger.debug "API called: UsersApi#patch_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1467
+ end
1468
+ return data, status_code, headers
1469
+ end
1470
+
1471
+ # Patch a user's CallForwarding
1472
+ #
1473
+ # @param user_id User ID
1474
+ # @param body Call forwarding
1475
+ # @param [Hash] opts the optional parameters
1476
+ # @return [CallForwarding]
1477
+ def patch_user_callforwarding(user_id, body, opts = {})
1478
+ data, _status_code, _headers = patch_user_callforwarding_with_http_info(user_id, body, opts)
1479
+ return data
1480
+ end
1481
+
1482
+ # Patch a user&#39;s CallForwarding
1483
+ #
1484
+ # @param user_id User ID
1485
+ # @param body Call forwarding
1486
+ # @param [Hash] opts the optional parameters
1487
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
1488
+ def patch_user_callforwarding_with_http_info(user_id, body, opts = {})
1489
+ if @api_client.config.debugging
1490
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_callforwarding ..."
1491
+ end
1492
+ # verify the required parameter 'user_id' is set
1493
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_callforwarding" if user_id.nil?
1494
+ # verify the required parameter 'body' is set
1495
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_callforwarding" if body.nil?
1496
+ # resource path
1497
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1498
+
1499
+ # query parameters
1500
+ query_params = {}
1501
+
1502
+ # header parameters
1503
+ header_params = {}
1504
+
1505
+ # HTTP header 'Accept' (if needed)
1506
+ local_header_accept = ['application/json']
1507
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1508
+
1509
+ # HTTP header 'Content-Type'
1510
+ local_header_content_type = ['application/json']
1511
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1512
+
1513
+ # form parameters
1514
+ form_params = {}
1515
+
1516
+ # http body (model)
1517
+ post_body = @api_client.object_to_http_body(body)
1518
+ auth_names = ['PureCloud Auth']
1519
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1520
+ :header_params => header_params,
1521
+ :query_params => query_params,
1522
+ :form_params => form_params,
1523
+ :body => post_body,
1524
+ :auth_names => auth_names,
1525
+ :return_type => 'CallForwarding')
1526
+ if @api_client.config.debugging
1527
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1528
+ end
1529
+ return data, status_code, headers
1530
+ end
1531
+
1532
+ # Patch a user's Geolocation
1533
+ # The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
1534
+ # @param user_id user Id
1535
+ # @param client_id client Id
1536
+ # @param body Geolocation
1537
+ # @param [Hash] opts the optional parameters
1538
+ # @return [Geolocation]
1539
+ def patch_user_geolocation(user_id, client_id, body, opts = {})
1540
+ data, _status_code, _headers = patch_user_geolocation_with_http_info(user_id, client_id, body, opts)
1541
+ return data
1542
+ end
1543
+
1544
+ # Patch a user&#39;s Geolocation
1545
+ # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
1546
+ # @param user_id user Id
1547
+ # @param client_id client Id
1548
+ # @param body Geolocation
1549
+ # @param [Hash] opts the optional parameters
1550
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
1551
+ def patch_user_geolocation_with_http_info(user_id, client_id, body, opts = {})
1552
+ if @api_client.config.debugging
1553
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_geolocation ..."
1554
+ end
1555
+ # verify the required parameter 'user_id' is set
1556
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_geolocation" if user_id.nil?
1557
+ # verify the required parameter 'client_id' is set
1558
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling UsersApi.patch_user_geolocation" if client_id.nil?
1559
+ # verify the required parameter 'body' is set
1560
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_geolocation" if body.nil?
1561
+ # resource path
1562
+ local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
1563
+
1564
+ # query parameters
1565
+ query_params = {}
1566
+
1567
+ # header parameters
1568
+ header_params = {}
1569
+
1570
+ # HTTP header 'Accept' (if needed)
1571
+ local_header_accept = ['application/json']
1572
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1573
+
1574
+ # HTTP header 'Content-Type'
1575
+ local_header_content_type = ['application/json']
1576
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1577
+
1578
+ # form parameters
1579
+ form_params = {}
1580
+
1581
+ # http body (model)
1582
+ post_body = @api_client.object_to_http_body(body)
1583
+ auth_names = ['PureCloud Auth']
1584
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1585
+ :header_params => header_params,
1586
+ :query_params => query_params,
1587
+ :form_params => form_params,
1588
+ :body => post_body,
1589
+ :auth_names => auth_names,
1590
+ :return_type => 'Geolocation')
1591
+ if @api_client.config.debugging
1592
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1593
+ end
1594
+ return data, status_code, headers
1595
+ end
1596
+
1597
+ # Join or unjoin a queue for a user
1598
+ #
1599
+ # @param queue_id Queue ID
1600
+ # @param user_id User ID
1601
+ # @param body Queue Member
1602
+ # @param [Hash] opts the optional parameters
1603
+ # @return [UserQueue]
1604
+ def patch_user_queue(queue_id, user_id, body, opts = {})
1605
+ data, _status_code, _headers = patch_user_queue_with_http_info(queue_id, user_id, body, opts)
1606
+ return data
1607
+ end
1608
+
1609
+ # Join or unjoin a queue for a user
1610
+ #
1611
+ # @param queue_id Queue ID
1612
+ # @param user_id User ID
1613
+ # @param body Queue Member
1614
+ # @param [Hash] opts the optional parameters
1615
+ # @return [Array<(UserQueue, Fixnum, Hash)>] UserQueue data, response status code and response headers
1616
+ def patch_user_queue_with_http_info(queue_id, user_id, body, opts = {})
1617
+ if @api_client.config.debugging
1618
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_queue ..."
1619
+ end
1620
+ # verify the required parameter 'queue_id' is set
1621
+ fail ArgumentError, "Missing the required parameter 'queue_id' when calling UsersApi.patch_user_queue" if queue_id.nil?
1622
+ # verify the required parameter 'user_id' is set
1623
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_queue" if user_id.nil?
1624
+ # verify the required parameter 'body' is set
1625
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_queue" if body.nil?
1626
+ # resource path
1627
+ local_var_path = "/api/v2/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1628
+
1629
+ # query parameters
1630
+ query_params = {}
1631
+
1632
+ # header parameters
1633
+ header_params = {}
1634
+
1635
+ # HTTP header 'Accept' (if needed)
1636
+ local_header_accept = ['application/json']
1637
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1638
+
1639
+ # HTTP header 'Content-Type'
1640
+ local_header_content_type = ['application/json']
1641
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1642
+
1643
+ # form parameters
1644
+ form_params = {}
1645
+
1646
+ # http body (model)
1647
+ post_body = @api_client.object_to_http_body(body)
1648
+ auth_names = ['PureCloud Auth']
1649
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1650
+ :header_params => header_params,
1651
+ :query_params => query_params,
1652
+ :form_params => form_params,
1653
+ :body => post_body,
1654
+ :auth_names => auth_names,
1655
+ :return_type => 'UserQueue')
1656
+ if @api_client.config.debugging
1657
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1658
+ end
1659
+ return data, status_code, headers
1660
+ end
1661
+
1662
+ # Join or unjoin a set of queues for a user
1663
+ #
1664
+ # @param user_id User ID
1665
+ # @param body User Queues
1666
+ # @param [Hash] opts the optional parameters
1667
+ # @return [UserQueueEntityListing]
1668
+ def patch_user_queues(user_id, body, opts = {})
1669
+ data, _status_code, _headers = patch_user_queues_with_http_info(user_id, body, opts)
1670
+ return data
1671
+ end
1672
+
1673
+ # Join or unjoin a set of queues for a user
1674
+ #
1675
+ # @param user_id User ID
1676
+ # @param body User Queues
1677
+ # @param [Hash] opts the optional parameters
1678
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
1679
+ def patch_user_queues_with_http_info(user_id, body, opts = {})
1680
+ if @api_client.config.debugging
1681
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_queues ..."
1682
+ end
1683
+ # verify the required parameter 'user_id' is set
1684
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_queues" if user_id.nil?
1685
+ # verify the required parameter 'body' is set
1686
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_queues" if body.nil?
1687
+ # resource path
1688
+ local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1689
+
1690
+ # query parameters
1691
+ query_params = {}
1692
+
1693
+ # header parameters
1694
+ header_params = {}
1695
+
1696
+ # HTTP header 'Accept' (if needed)
1697
+ local_header_accept = ['application/json']
1698
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1699
+
1700
+ # HTTP header 'Content-Type'
1701
+ local_header_content_type = ['application/json']
1702
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1703
+
1704
+ # form parameters
1705
+ form_params = {}
1706
+
1707
+ # http body (model)
1708
+ post_body = @api_client.object_to_http_body(body)
1709
+ auth_names = ['PureCloud Auth']
1710
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1711
+ :header_params => header_params,
1712
+ :query_params => query_params,
1713
+ :form_params => form_params,
1714
+ :body => post_body,
1715
+ :auth_names => auth_names,
1716
+ :return_type => 'UserQueueEntityListing')
1717
+ if @api_client.config.debugging
1718
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1719
+ end
1720
+ return data, status_code, headers
1721
+ end
1722
+
1723
+ # Query for user aggregates
1724
+ #
1725
+ # @param body query
1726
+ # @param [Hash] opts the optional parameters
1727
+ # @return [PresenceQueryResponse]
1728
+ def post_analytics_users_aggregates_query(body, opts = {})
1729
+ data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
1730
+ return data
1731
+ end
1732
+
1733
+ # Query for user aggregates
1734
+ #
1735
+ # @param body query
1736
+ # @param [Hash] opts the optional parameters
1737
+ # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
1738
+ def post_analytics_users_aggregates_query_with_http_info(body, opts = {})
1739
+ if @api_client.config.debugging
1740
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_aggregates_query ..."
1741
+ end
1742
+ # verify the required parameter 'body' is set
1743
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_aggregates_query" if body.nil?
1744
+ # resource path
1745
+ local_var_path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json')
1746
+
1747
+ # query parameters
1748
+ query_params = {}
1749
+
1750
+ # header parameters
1751
+ header_params = {}
1752
+
1753
+ # HTTP header 'Accept' (if needed)
1754
+ local_header_accept = ['application/json']
1755
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1756
+
1757
+ # HTTP header 'Content-Type'
1758
+ local_header_content_type = ['application/json']
1759
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1760
+
1761
+ # form parameters
1762
+ form_params = {}
1763
+
1764
+ # http body (model)
1765
+ post_body = @api_client.object_to_http_body(body)
1766
+ auth_names = ['PureCloud Auth']
1767
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1768
+ :header_params => header_params,
1769
+ :query_params => query_params,
1770
+ :form_params => form_params,
1771
+ :body => post_body,
1772
+ :auth_names => auth_names,
1773
+ :return_type => 'PresenceQueryResponse')
1774
+ if @api_client.config.debugging
1775
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1776
+ end
1777
+ return data, status_code, headers
1778
+ end
1779
+
1780
+ # Query for user details
1781
+ #
1782
+ # @param body query
1783
+ # @param [Hash] opts the optional parameters
1784
+ # @return [AnalyticsUserDetailsQueryResponse]
1785
+ def post_analytics_users_details_query(body, opts = {})
1786
+ data, _status_code, _headers = post_analytics_users_details_query_with_http_info(body, opts)
1787
+ return data
1788
+ end
1789
+
1790
+ # Query for user details
1791
+ #
1792
+ # @param body query
1793
+ # @param [Hash] opts the optional parameters
1794
+ # @return [Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse data, response status code and response headers
1795
+ def post_analytics_users_details_query_with_http_info(body, opts = {})
1796
+ if @api_client.config.debugging
1797
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_details_query ..."
1798
+ end
1799
+ # verify the required parameter 'body' is set
1800
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_details_query" if body.nil?
1801
+ # resource path
1802
+ local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json')
1803
+
1804
+ # query parameters
1805
+ query_params = {}
1806
+
1807
+ # header parameters
1808
+ header_params = {}
1809
+
1810
+ # HTTP header 'Accept' (if needed)
1811
+ local_header_accept = ['application/json']
1812
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1813
+
1814
+ # HTTP header 'Content-Type'
1815
+ local_header_content_type = ['application/json']
1816
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1817
+
1818
+ # form parameters
1819
+ form_params = {}
1820
+
1821
+ # http body (model)
1822
+ post_body = @api_client.object_to_http_body(body)
1823
+ auth_names = ['PureCloud Auth']
1824
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1825
+ :header_params => header_params,
1826
+ :query_params => query_params,
1827
+ :form_params => form_params,
1828
+ :body => post_body,
1829
+ :auth_names => auth_names,
1830
+ :return_type => 'AnalyticsUserDetailsQueryResponse')
1831
+ if @api_client.config.debugging
1832
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1833
+ end
1834
+ return data, status_code, headers
1835
+ end
1836
+
1837
+ # Query for user observations
1838
+ #
1839
+ # @param body query
1840
+ # @param [Hash] opts the optional parameters
1841
+ # @return [ObservationQueryResponse]
1842
+ def post_analytics_users_observations_query(body, opts = {})
1843
+ data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
1844
+ return data
1845
+ end
1846
+
1847
+ # Query for user observations
1848
+ #
1849
+ # @param body query
1850
+ # @param [Hash] opts the optional parameters
1851
+ # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
1852
+ def post_analytics_users_observations_query_with_http_info(body, opts = {})
1853
+ if @api_client.config.debugging
1854
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_observations_query ..."
1855
+ end
1856
+ # verify the required parameter 'body' is set
1857
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_observations_query" if body.nil?
1858
+ # resource path
1859
+ local_var_path = "/api/v2/analytics/users/observations/query".sub('{format}','json')
1860
+
1861
+ # query parameters
1862
+ query_params = {}
1863
+
1864
+ # header parameters
1865
+ header_params = {}
1866
+
1867
+ # HTTP header 'Accept' (if needed)
1868
+ local_header_accept = ['application/json']
1869
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1870
+
1871
+ # HTTP header 'Content-Type'
1872
+ local_header_content_type = ['application/json']
1873
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1874
+
1875
+ # form parameters
1876
+ form_params = {}
1877
+
1878
+ # http body (model)
1879
+ post_body = @api_client.object_to_http_body(body)
1880
+ auth_names = ['PureCloud Auth']
1881
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1882
+ :header_params => header_params,
1883
+ :query_params => query_params,
1884
+ :form_params => form_params,
1885
+ :body => post_body,
1886
+ :auth_names => auth_names,
1887
+ :return_type => 'ObservationQueryResponse')
1888
+ if @api_client.config.debugging
1889
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1890
+ end
1891
+ return data, status_code, headers
1892
+ end
1893
+
1894
+ # Add routing skill to user
1895
+ #
1896
+ # @param user_id User ID
1897
+ # @param body Skill
1898
+ # @param [Hash] opts the optional parameters
1899
+ # @return [UserRoutingSkill]
1900
+ def post_user_routingskills(user_id, body, opts = {})
1901
+ data, _status_code, _headers = post_user_routingskills_with_http_info(user_id, body, opts)
1902
+ return data
1903
+ end
1904
+
1905
+ # Add routing skill to user
1906
+ #
1907
+ # @param user_id User ID
1908
+ # @param body Skill
1909
+ # @param [Hash] opts the optional parameters
1910
+ # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers
1911
+ def post_user_routingskills_with_http_info(user_id, body, opts = {})
1912
+ if @api_client.config.debugging
1913
+ @api_client.config.logger.debug "Calling API: UsersApi.post_user_routingskills ..."
1914
+ end
1915
+ # verify the required parameter 'user_id' is set
1916
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.post_user_routingskills" if user_id.nil?
1917
+ # verify the required parameter 'body' is set
1918
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_user_routingskills" if body.nil?
1919
+ # resource path
1920
+ local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1921
+
1922
+ # query parameters
1923
+ query_params = {}
1924
+
1925
+ # header parameters
1926
+ header_params = {}
1927
+
1928
+ # HTTP header 'Accept' (if needed)
1929
+ local_header_accept = ['application/json']
1930
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1931
+
1932
+ # HTTP header 'Content-Type'
1933
+ local_header_content_type = ['application/json']
1934
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1935
+
1936
+ # form parameters
1937
+ form_params = {}
1938
+
1939
+ # http body (model)
1940
+ post_body = @api_client.object_to_http_body(body)
1941
+ auth_names = ['PureCloud Auth']
1942
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1943
+ :header_params => header_params,
1944
+ :query_params => query_params,
1945
+ :form_params => form_params,
1946
+ :body => post_body,
1947
+ :auth_names => auth_names,
1948
+ :return_type => 'UserRoutingSkill')
1949
+ if @api_client.config.debugging
1950
+ @api_client.config.logger.debug "API called: UsersApi#post_user_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1951
+ end
1952
+ return data, status_code, headers
1953
+ end
1954
+
1955
+ # Create user
1956
+ #
1957
+ # @param body User
1958
+ # @param [Hash] opts the optional parameters
1959
+ # @return [User]
1960
+ def post_users(body, opts = {})
1961
+ data, _status_code, _headers = post_users_with_http_info(body, opts)
1962
+ return data
1963
+ end
1964
+
1965
+ # Create user
1966
+ #
1967
+ # @param body User
1968
+ # @param [Hash] opts the optional parameters
1969
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
1970
+ def post_users_with_http_info(body, opts = {})
1971
+ if @api_client.config.debugging
1972
+ @api_client.config.logger.debug "Calling API: UsersApi.post_users ..."
1973
+ end
1974
+ # verify the required parameter 'body' is set
1975
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_users" if body.nil?
1976
+ # resource path
1977
+ local_var_path = "/api/v2/users".sub('{format}','json')
1978
+
1979
+ # query parameters
1980
+ query_params = {}
1981
+
1982
+ # header parameters
1983
+ header_params = {}
1984
+
1985
+ # HTTP header 'Accept' (if needed)
1986
+ local_header_accept = ['application/json']
1987
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1988
+
1989
+ # HTTP header 'Content-Type'
1990
+ local_header_content_type = ['application/json']
1991
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1992
+
1993
+ # form parameters
1994
+ form_params = {}
1995
+
1996
+ # http body (model)
1997
+ post_body = @api_client.object_to_http_body(body)
1998
+ auth_names = ['PureCloud Auth']
1999
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2000
+ :header_params => header_params,
2001
+ :query_params => query_params,
2002
+ :form_params => form_params,
2003
+ :body => post_body,
2004
+ :auth_names => auth_names,
2005
+ :return_type => 'User')
2006
+ if @api_client.config.debugging
2007
+ @api_client.config.logger.debug "API called: UsersApi#post_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2008
+ end
2009
+ return data, status_code, headers
2010
+ end
2011
+
2012
+ # Search users
2013
+ #
2014
+ # @param body Search request options
2015
+ # @param [Hash] opts the optional parameters
2016
+ # @return [UsersSearchResponse]
2017
+ def post_users_search(body, opts = {})
2018
+ data, _status_code, _headers = post_users_search_with_http_info(body, opts)
2019
+ return data
2020
+ end
2021
+
2022
+ # Search users
2023
+ #
2024
+ # @param body Search request options
2025
+ # @param [Hash] opts the optional parameters
2026
+ # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
2027
+ def post_users_search_with_http_info(body, opts = {})
2028
+ if @api_client.config.debugging
2029
+ @api_client.config.logger.debug "Calling API: UsersApi.post_users_search ..."
2030
+ end
2031
+ # verify the required parameter 'body' is set
2032
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_users_search" if body.nil?
2033
+ # resource path
2034
+ local_var_path = "/api/v2/users/search".sub('{format}','json')
2035
+
2036
+ # query parameters
2037
+ query_params = {}
2038
+
2039
+ # header parameters
2040
+ header_params = {}
2041
+
2042
+ # HTTP header 'Accept' (if needed)
2043
+ local_header_accept = ['application/json']
2044
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2045
+
2046
+ # HTTP header 'Content-Type'
2047
+ local_header_content_type = ['application/json']
2048
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2049
+
2050
+ # form parameters
2051
+ form_params = {}
2052
+
2053
+ # http body (model)
2054
+ post_body = @api_client.object_to_http_body(body)
2055
+ auth_names = ['PureCloud Auth']
2056
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2057
+ :header_params => header_params,
2058
+ :query_params => query_params,
2059
+ :form_params => form_params,
2060
+ :body => post_body,
2061
+ :auth_names => auth_names,
2062
+ :return_type => 'UsersSearchResponse')
2063
+ if @api_client.config.debugging
2064
+ @api_client.config.logger.debug "API called: UsersApi#post_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2065
+ end
2066
+ return data, status_code, headers
2067
+ end
2068
+
2069
+ # Update a user's CallForwarding
2070
+ #
2071
+ # @param user_id User ID
2072
+ # @param body Call forwarding
2073
+ # @param [Hash] opts the optional parameters
2074
+ # @return [CallForwarding]
2075
+ def put_user_callforwarding(user_id, body, opts = {})
2076
+ data, _status_code, _headers = put_user_callforwarding_with_http_info(user_id, body, opts)
2077
+ return data
2078
+ end
2079
+
2080
+ # Update a user&#39;s CallForwarding
2081
+ #
2082
+ # @param user_id User ID
2083
+ # @param body Call forwarding
2084
+ # @param [Hash] opts the optional parameters
2085
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
2086
+ def put_user_callforwarding_with_http_info(user_id, body, opts = {})
2087
+ if @api_client.config.debugging
2088
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_callforwarding ..."
2089
+ end
2090
+ # verify the required parameter 'user_id' is set
2091
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_callforwarding" if user_id.nil?
2092
+ # verify the required parameter 'body' is set
2093
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_callforwarding" if body.nil?
2094
+ # resource path
2095
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2096
+
2097
+ # query parameters
2098
+ query_params = {}
2099
+
2100
+ # header parameters
2101
+ header_params = {}
2102
+
2103
+ # HTTP header 'Accept' (if needed)
2104
+ local_header_accept = ['application/json']
2105
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2106
+
2107
+ # HTTP header 'Content-Type'
2108
+ local_header_content_type = ['application/json']
2109
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2110
+
2111
+ # form parameters
2112
+ form_params = {}
2113
+
2114
+ # http body (model)
2115
+ post_body = @api_client.object_to_http_body(body)
2116
+ auth_names = ['PureCloud Auth']
2117
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2118
+ :header_params => header_params,
2119
+ :query_params => query_params,
2120
+ :form_params => form_params,
2121
+ :body => post_body,
2122
+ :auth_names => auth_names,
2123
+ :return_type => 'CallForwarding')
2124
+ if @api_client.config.debugging
2125
+ @api_client.config.logger.debug "API called: UsersApi#put_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2126
+ end
2127
+ return data, status_code, headers
2128
+ end
2129
+
2130
+ # Update an OutOfOffice
2131
+ #
2132
+ # @param user_id User ID
2133
+ # @param body The updated UserPresence
2134
+ # @param [Hash] opts the optional parameters
2135
+ # @return [OutOfOffice]
2136
+ def put_user_outofoffice(user_id, body, opts = {})
2137
+ data, _status_code, _headers = put_user_outofoffice_with_http_info(user_id, body, opts)
2138
+ return data
2139
+ end
2140
+
2141
+ # Update an OutOfOffice
2142
+ #
2143
+ # @param user_id User ID
2144
+ # @param body The updated UserPresence
2145
+ # @param [Hash] opts the optional parameters
2146
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
2147
+ def put_user_outofoffice_with_http_info(user_id, body, opts = {})
2148
+ if @api_client.config.debugging
2149
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_outofoffice ..."
2150
+ end
2151
+ # verify the required parameter 'user_id' is set
2152
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_outofoffice" if user_id.nil?
2153
+ # verify the required parameter 'body' is set
2154
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_outofoffice" if body.nil?
2155
+ # resource path
2156
+ local_var_path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2157
+
2158
+ # query parameters
2159
+ query_params = {}
2160
+
2161
+ # header parameters
2162
+ header_params = {}
2163
+
2164
+ # HTTP header 'Accept' (if needed)
2165
+ local_header_accept = ['application/json']
2166
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2167
+
2168
+ # HTTP header 'Content-Type'
2169
+ local_header_content_type = ['application/json']
2170
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2171
+
2172
+ # form parameters
2173
+ form_params = {}
2174
+
2175
+ # http body (model)
2176
+ post_body = @api_client.object_to_http_body(body)
2177
+ auth_names = ['PureCloud Auth']
2178
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2179
+ :header_params => header_params,
2180
+ :query_params => query_params,
2181
+ :form_params => form_params,
2182
+ :body => post_body,
2183
+ :auth_names => auth_names,
2184
+ :return_type => 'OutOfOffice')
2185
+ if @api_client.config.debugging
2186
+ @api_client.config.logger.debug "API called: UsersApi#put_user_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2187
+ end
2188
+ return data, status_code, headers
2189
+ end
2190
+
2191
+ # Update profile skills for a user
2192
+ #
2193
+ # @param user_id User ID
2194
+ # @param [Hash] opts the optional parameters
2195
+ # @option opts [Array<String>] :body Skills
2196
+ # @return [Array<String>]
2197
+ def put_user_profileskills(user_id, opts = {})
2198
+ data, _status_code, _headers = put_user_profileskills_with_http_info(user_id, opts)
2199
+ return data
2200
+ end
2201
+
2202
+ # Update profile skills for a user
2203
+ #
2204
+ # @param user_id User ID
2205
+ # @param [Hash] opts the optional parameters
2206
+ # @option opts [Array<String>] :body Skills
2207
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
2208
+ def put_user_profileskills_with_http_info(user_id, opts = {})
2209
+ if @api_client.config.debugging
2210
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_profileskills ..."
2211
+ end
2212
+ # verify the required parameter 'user_id' is set
2213
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_profileskills" if user_id.nil?
2214
+ # resource path
2215
+ local_var_path = "/api/v2/users/{userId}/profileskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2216
+
2217
+ # query parameters
2218
+ query_params = {}
2219
+
2220
+ # header parameters
2221
+ header_params = {}
2222
+
2223
+ # HTTP header 'Accept' (if needed)
2224
+ local_header_accept = ['application/json']
2225
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2226
+
2227
+ # HTTP header 'Content-Type'
2228
+ local_header_content_type = ['application/json']
2229
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2230
+
2231
+ # form parameters
2232
+ form_params = {}
2233
+
2234
+ # http body (model)
2235
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2236
+ auth_names = ['PureCloud Auth']
2237
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2238
+ :header_params => header_params,
2239
+ :query_params => query_params,
2240
+ :form_params => form_params,
2241
+ :body => post_body,
2242
+ :auth_names => auth_names,
2243
+ :return_type => 'Array<String>')
2244
+ if @api_client.config.debugging
2245
+ @api_client.config.logger.debug "API called: UsersApi#put_user_profileskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2246
+ end
2247
+ return data, status_code, headers
2248
+ end
2249
+
2250
+ # Sets the user's roles
2251
+ #
2252
+ # @param user_id User ID
2253
+ # @param body List of roles
2254
+ # @param [Hash] opts the optional parameters
2255
+ # @return [UserAuthorization]
2256
+ def put_user_roles(user_id, body, opts = {})
2257
+ data, _status_code, _headers = put_user_roles_with_http_info(user_id, body, opts)
2258
+ return data
2259
+ end
2260
+
2261
+ # Sets the user&#39;s roles
2262
+ #
2263
+ # @param user_id User ID
2264
+ # @param body List of roles
2265
+ # @param [Hash] opts the optional parameters
2266
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
2267
+ def put_user_roles_with_http_info(user_id, body, opts = {})
2268
+ if @api_client.config.debugging
2269
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_roles ..."
2270
+ end
2271
+ # verify the required parameter 'user_id' is set
2272
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_roles" if user_id.nil?
2273
+ # verify the required parameter 'body' is set
2274
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_roles" if body.nil?
2275
+ # resource path
2276
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2277
+
2278
+ # query parameters
2279
+ query_params = {}
2280
+
2281
+ # header parameters
2282
+ header_params = {}
2283
+
2284
+ # HTTP header 'Accept' (if needed)
2285
+ local_header_accept = ['application/json']
2286
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2287
+
2288
+ # HTTP header 'Content-Type'
2289
+ local_header_content_type = ['application/json']
2290
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2291
+
2292
+ # form parameters
2293
+ form_params = {}
2294
+
2295
+ # http body (model)
2296
+ post_body = @api_client.object_to_http_body(body)
2297
+ auth_names = ['PureCloud Auth']
2298
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2299
+ :header_params => header_params,
2300
+ :query_params => query_params,
2301
+ :form_params => form_params,
2302
+ :body => post_body,
2303
+ :auth_names => auth_names,
2304
+ :return_type => 'UserAuthorization')
2305
+ if @api_client.config.debugging
2306
+ @api_client.config.logger.debug "API called: UsersApi#put_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2307
+ end
2308
+ return data, status_code, headers
2309
+ end
2310
+
2311
+ # Update routing skill proficiency or state.
2312
+ #
2313
+ # @param user_id User ID
2314
+ # @param skill_id skillId
2315
+ # @param body Skill
2316
+ # @param [Hash] opts the optional parameters
2317
+ # @return [UserRoutingSkill]
2318
+ def put_user_routingskill(user_id, skill_id, body, opts = {})
2319
+ data, _status_code, _headers = put_user_routingskill_with_http_info(user_id, skill_id, body, opts)
2320
+ return data
2321
+ end
2322
+
2323
+ # Update routing skill proficiency or state.
2324
+ #
2325
+ # @param user_id User ID
2326
+ # @param skill_id skillId
2327
+ # @param body Skill
2328
+ # @param [Hash] opts the optional parameters
2329
+ # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers
2330
+ def put_user_routingskill_with_http_info(user_id, skill_id, body, opts = {})
2331
+ if @api_client.config.debugging
2332
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_routingskill ..."
2333
+ end
2334
+ # verify the required parameter 'user_id' is set
2335
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_routingskill" if user_id.nil?
2336
+ # verify the required parameter 'skill_id' is set
2337
+ fail ArgumentError, "Missing the required parameter 'skill_id' when calling UsersApi.put_user_routingskill" if skill_id.nil?
2338
+ # verify the required parameter 'body' is set
2339
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_routingskill" if body.nil?
2340
+ # resource path
2341
+ local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)
2342
+
2343
+ # query parameters
2344
+ query_params = {}
2345
+
2346
+ # header parameters
2347
+ header_params = {}
2348
+
2349
+ # HTTP header 'Accept' (if needed)
2350
+ local_header_accept = ['application/json']
2351
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2352
+
2353
+ # HTTP header 'Content-Type'
2354
+ local_header_content_type = ['application/json']
2355
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2356
+
2357
+ # form parameters
2358
+ form_params = {}
2359
+
2360
+ # http body (model)
2361
+ post_body = @api_client.object_to_http_body(body)
2362
+ auth_names = ['PureCloud Auth']
2363
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2364
+ :header_params => header_params,
2365
+ :query_params => query_params,
2366
+ :form_params => form_params,
2367
+ :body => post_body,
2368
+ :auth_names => auth_names,
2369
+ :return_type => 'UserRoutingSkill')
2370
+ if @api_client.config.debugging
2371
+ @api_client.config.logger.debug "API called: UsersApi#put_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2372
+ end
2373
+ return data, status_code, headers
2374
+ end
2375
+
2376
+ # Update the routing status of a user
2377
+ #
2378
+ # @param user_id User ID
2379
+ # @param body Routing Status
2380
+ # @param [Hash] opts the optional parameters
2381
+ # @return [RoutingStatus]
2382
+ def put_user_routingstatus(user_id, body, opts = {})
2383
+ data, _status_code, _headers = put_user_routingstatus_with_http_info(user_id, body, opts)
2384
+ return data
2385
+ end
2386
+
2387
+ # Update the routing status of a user
2388
+ #
2389
+ # @param user_id User ID
2390
+ # @param body Routing Status
2391
+ # @param [Hash] opts the optional parameters
2392
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
2393
+ def put_user_routingstatus_with_http_info(user_id, body, opts = {})
2394
+ if @api_client.config.debugging
2395
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_routingstatus ..."
2396
+ end
2397
+ # verify the required parameter 'user_id' is set
2398
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_routingstatus" if user_id.nil?
2399
+ # verify the required parameter 'body' is set
2400
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_routingstatus" if body.nil?
2401
+ # resource path
2402
+ local_var_path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2403
+
2404
+ # query parameters
2405
+ query_params = {}
2406
+
2407
+ # header parameters
2408
+ header_params = {}
2409
+
2410
+ # HTTP header 'Accept' (if needed)
2411
+ local_header_accept = ['application/json']
2412
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2413
+
2414
+ # HTTP header 'Content-Type'
2415
+ local_header_content_type = ['application/json']
2416
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2417
+
2418
+ # form parameters
2419
+ form_params = {}
2420
+
2421
+ # http body (model)
2422
+ post_body = @api_client.object_to_http_body(body)
2423
+ auth_names = ['PureCloud Auth']
2424
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2425
+ :header_params => header_params,
2426
+ :query_params => query_params,
2427
+ :form_params => form_params,
2428
+ :body => post_body,
2429
+ :auth_names => auth_names,
2430
+ :return_type => 'RoutingStatus')
2431
+ if @api_client.config.debugging
2432
+ @api_client.config.logger.debug "API called: UsersApi#put_user_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2433
+ end
2434
+ return data, status_code, headers
2435
+ end
2436
+
2437
+ # Set associated station
2438
+ #
2439
+ # @param user_id User ID
2440
+ # @param station_id stationId
2441
+ # @param [Hash] opts the optional parameters
2442
+ # @return [nil]
2443
+ def put_user_station_associatedstation_station_id(user_id, station_id, opts = {})
2444
+ put_user_station_associatedstation_station_id_with_http_info(user_id, station_id, opts)
2445
+ return nil
2446
+ end
2447
+
2448
+ # Set associated station
2449
+ #
2450
+ # @param user_id User ID
2451
+ # @param station_id stationId
2452
+ # @param [Hash] opts the optional parameters
2453
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2454
+ def put_user_station_associatedstation_station_id_with_http_info(user_id, station_id, opts = {})
2455
+ if @api_client.config.debugging
2456
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_station_associatedstation_station_id ..."
2457
+ end
2458
+ # verify the required parameter 'user_id' is set
2459
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_station_associatedstation_station_id" if user_id.nil?
2460
+ # verify the required parameter 'station_id' is set
2461
+ fail ArgumentError, "Missing the required parameter 'station_id' when calling UsersApi.put_user_station_associatedstation_station_id" if station_id.nil?
2462
+ # resource path
2463
+ local_var_path = "/api/v2/users/{userId}/station/associatedstation/{stationId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'stationId' + '}', station_id.to_s)
2464
+
2465
+ # query parameters
2466
+ query_params = {}
2467
+
2468
+ # header parameters
2469
+ header_params = {}
2470
+
2471
+ # HTTP header 'Accept' (if needed)
2472
+ local_header_accept = ['application/json']
2473
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2474
+
2475
+ # HTTP header 'Content-Type'
2476
+ local_header_content_type = ['application/json']
2477
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2478
+
2479
+ # form parameters
2480
+ form_params = {}
2481
+
2482
+ # http body (model)
2483
+ post_body = nil
2484
+ auth_names = ['PureCloud Auth']
2485
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2486
+ :header_params => header_params,
2487
+ :query_params => query_params,
2488
+ :form_params => form_params,
2489
+ :body => post_body,
2490
+ :auth_names => auth_names)
2491
+ if @api_client.config.debugging
2492
+ @api_client.config.logger.debug "API called: UsersApi#put_user_station_associatedstation_station_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2493
+ end
2494
+ return data, status_code, headers
2495
+ end
2496
+
2497
+ # Set default station
2498
+ #
2499
+ # @param user_id User ID
2500
+ # @param station_id stationId
2501
+ # @param [Hash] opts the optional parameters
2502
+ # @return [nil]
2503
+ def put_user_station_defaultstation_station_id(user_id, station_id, opts = {})
2504
+ put_user_station_defaultstation_station_id_with_http_info(user_id, station_id, opts)
2505
+ return nil
2506
+ end
2507
+
2508
+ # Set default station
2509
+ #
2510
+ # @param user_id User ID
2511
+ # @param station_id stationId
2512
+ # @param [Hash] opts the optional parameters
2513
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2514
+ def put_user_station_defaultstation_station_id_with_http_info(user_id, station_id, opts = {})
2515
+ if @api_client.config.debugging
2516
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_station_defaultstation_station_id ..."
2517
+ end
2518
+ # verify the required parameter 'user_id' is set
2519
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_station_defaultstation_station_id" if user_id.nil?
2520
+ # verify the required parameter 'station_id' is set
2521
+ fail ArgumentError, "Missing the required parameter 'station_id' when calling UsersApi.put_user_station_defaultstation_station_id" if station_id.nil?
2522
+ # resource path
2523
+ local_var_path = "/api/v2/users/{userId}/station/defaultstation/{stationId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'stationId' + '}', station_id.to_s)
2524
+
2525
+ # query parameters
2526
+ query_params = {}
2527
+
2528
+ # header parameters
2529
+ header_params = {}
2530
+
2531
+ # HTTP header 'Accept' (if needed)
2532
+ local_header_accept = ['application/json']
2533
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2534
+
2535
+ # HTTP header 'Content-Type'
2536
+ local_header_content_type = ['application/json']
2537
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2538
+
2539
+ # form parameters
2540
+ form_params = {}
2541
+
2542
+ # http body (model)
2543
+ post_body = nil
2544
+ auth_names = ['PureCloud Auth']
2545
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2546
+ :header_params => header_params,
2547
+ :query_params => query_params,
2548
+ :form_params => form_params,
2549
+ :body => post_body,
2550
+ :auth_names => auth_names)
2551
+ if @api_client.config.debugging
2552
+ @api_client.config.logger.debug "API called: UsersApi#put_user_station_defaultstation_station_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2553
+ end
2554
+ return data, status_code, headers
2555
+ end
2556
+ end
2557
+ end