purecloud 0.35.1 → 0.36.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1459) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +0 -1
  3. data/Gemfile.lock +0 -2
  4. data/README.md +38 -51
  5. data/config-ruby.json +1 -1
  6. data/doc_out/Account.html.md +42 -0
  7. data/doc_out/AccountManager.html.md +16 -0
  8. data/doc_out/AccountOverview.html.md +20 -0
  9. data/doc_out/AccountStatus.html.md +21 -0
  10. data/doc_out/Actions.html.md +13 -0
  11. data/doc_out/AcwSettings.html.md +14 -0
  12. data/doc_out/Address.html.md +20 -0
  13. data/doc_out/AddressListing.html.md +22 -0
  14. data/doc_out/Agent.html.md +13 -0
  15. data/doc_out/AgentActivity.html.md +19 -0
  16. data/doc_out/AgentActivityEntityListing.html.md +22 -0
  17. data/doc_out/AgentEvaluatorActivity.html.md +19 -0
  18. data/doc_out/AggregateDataContainer.html.md +14 -0
  19. data/doc_out/AggregateMetricData.html.md +15 -0
  20. data/doc_out/AggregateQueryResponse.html.md +13 -0
  21. data/doc_out/AggregationQuery.html.md +18 -0
  22. data/doc_out/AggregationRange.html.md +14 -0
  23. data/doc_out/AggregationResult.html.md +17 -0
  24. data/doc_out/AggregationResultEntry.html.md +16 -0
  25. data/doc_out/AlertingApi.html.md +571 -0
  26. data/doc_out/AnalyticsApi.html.md +1233 -0
  27. data/doc_out/AnalyticsConversation.html.md +16 -0
  28. data/doc_out/AnalyticsConversationQueryResponse.html.md +14 -0
  29. data/doc_out/AnalyticsConversationSegment.html.md +34 -0
  30. data/doc_out/AnalyticsEvaluation.html.md +22 -0
  31. data/doc_out/AnalyticsParticipant.html.md +17 -0
  32. data/doc_out/AnalyticsProperty.html.md +15 -0
  33. data/doc_out/AnalyticsQueryAggregation.html.md +17 -0
  34. data/doc_out/AnalyticsQueryClause.html.md +14 -0
  35. data/doc_out/AnalyticsQueryFilter.html.md +15 -0
  36. data/doc_out/AnalyticsQueryPredicate.html.md +20 -0
  37. data/doc_out/AnalyticsSession.html.md +29 -0
  38. data/doc_out/Annotation.html.md +20 -0
  39. data/doc_out/App.html.md +14 -0
  40. data/doc_out/ArchiveRetention.html.md +14 -0
  41. data/doc_out/AssociatedDocument.html.md +14 -0
  42. data/doc_out/Attachment.html.md +17 -0
  43. data/doc_out/Attribute.html.md +21 -0
  44. data/doc_out/AttributeEntityListing.html.md +22 -0
  45. data/doc_out/AttributeFilterItem.html.md +15 -0
  46. data/doc_out/AttributeQueryRequest.html.md +15 -0
  47. data/doc_out/AttributesApi.html.md +362 -0
  48. data/doc_out/AuditChange.html.md +16 -0
  49. data/doc_out/AuditEntity.html.md +16 -0
  50. data/doc_out/AuditEntityReference.html.md +17 -0
  51. data/doc_out/AuditFacet.html.md +14 -0
  52. data/doc_out/AuditFilter.html.md +16 -0
  53. data/doc_out/AuditMessage.html.md +28 -0
  54. data/doc_out/AuditSearchResult.html.md +18 -0
  55. data/doc_out/AuditUser.html.md +15 -0
  56. data/doc_out/AuthorizationApi.html.md +1024 -0
  57. data/doc_out/AutomateQueue.html.md +19 -0
  58. data/doc_out/AutomateQueueMember.html.md +16 -0
  59. data/doc_out/AutomateQueueMemberEntityListing.html.md +22 -0
  60. data/doc_out/AvailableAdditionalService.html.md +22 -0
  61. data/doc_out/AvailableAdditionalServiceListing.html.md +22 -0
  62. data/doc_out/AvailableTopic.html.md +15 -0
  63. data/doc_out/AvailableTopicEntityListing.html.md +22 -0
  64. data/doc_out/BackendFlowAvailableActions.html.md +13 -0
  65. data/doc_out/BasicTransform.html.md +14 -0
  66. data/doc_out/BatchCommand.html.md +14 -0
  67. data/doc_out/BatchItem.html.md +15 -0
  68. data/doc_out/BatchItemBody.html.md +13 -0
  69. data/doc_out/BatchReply.html.md +13 -0
  70. data/doc_out/BatchReplyItem.html.md +15 -0
  71. data/doc_out/BillingAddress.html.md +20 -0
  72. data/doc_out/BillingPeriod.html.md +17 -0
  73. data/doc_out/Bullseye.html.md +13 -0
  74. data/doc_out/Calibration.html.md +28 -0
  75. data/doc_out/CalibrationAssignment.html.md +16 -0
  76. data/doc_out/CalibrationEntityListing.html.md +22 -0
  77. data/doc_out/Call.html.md +29 -0
  78. data/doc_out/CallCommand.html.md +13 -0
  79. data/doc_out/CallConversation.html.md +18 -0
  80. data/doc_out/CallConversationEntityListing.html.md +22 -0
  81. data/doc_out/CallForwarding.html.md +19 -0
  82. data/doc_out/CallMediaParticipant.html.md +43 -0
  83. data/doc_out/CallRecord.html.md +14 -0
  84. data/doc_out/CallableContactsDiagnostic.html.md +15 -0
  85. data/doc_out/CallableTime.html.md +14 -0
  86. data/doc_out/CallableTimeSet.html.md +19 -0
  87. data/doc_out/CallableTimeSetEntityListing.html.md +22 -0
  88. data/doc_out/Callback.html.md +27 -0
  89. data/doc_out/CallbackConversation.html.md +17 -0
  90. data/doc_out/CallbackConversationEntityListing.html.md +22 -0
  91. data/doc_out/CallbackMediaParticipant.html.md +38 -0
  92. data/doc_out/Campaign.html.md +38 -0
  93. data/doc_out/CampaignDiagnostics.html.md +15 -0
  94. data/doc_out/CampaignEntityListing.html.md +22 -0
  95. data/doc_out/CampaignProgress.html.md +17 -0
  96. data/doc_out/CampaignSchedule.html.md +21 -0
  97. data/doc_out/CampaignScheduleIntervals.html.md +14 -0
  98. data/doc_out/CampaignSequence.html.md +23 -0
  99. data/doc_out/CampaignSequenceEntityListing.html.md +22 -0
  100. data/doc_out/CampaignStats.html.md +16 -0
  101. data/doc_out/CampaignTimeSlot.html.md +15 -0
  102. data/doc_out/Carrier.html.md +20 -0
  103. data/doc_out/CarrierAddress.html.md +17 -0
  104. data/doc_out/CarrierEntityListing.html.md +22 -0
  105. data/doc_out/Certificate.html.md +13 -0
  106. data/doc_out/CertificateAuthorityEntityListing.html.md +22 -0
  107. data/doc_out/CertificateDetails.html.md +19 -0
  108. data/doc_out/Change.html.md +16 -0
  109. data/doc_out/Channel.html.md +14 -0
  110. data/doc_out/ChannelEntityListing.html.md +22 -0
  111. data/doc_out/ChannelTopic.html.md +14 -0
  112. data/doc_out/ChannelTopicEntityListing.html.md +22 -0
  113. data/doc_out/Charge.html.md +20 -0
  114. data/doc_out/Chat.html.md +13 -0
  115. data/doc_out/ChatConversation.html.md +17 -0
  116. data/doc_out/ChatConversationEntityListing.html.md +22 -0
  117. data/doc_out/ChatMediaParticipant.html.md +34 -0
  118. data/doc_out/ChatMessage.html.md +21 -0
  119. data/doc_out/ChatMessageUser.html.md +17 -0
  120. data/doc_out/ClientSpreadsheetTransform.html.md +19 -0
  121. data/doc_out/ClientTextTableTransform.html.md +20 -0
  122. data/doc_out/ColumnCollapse.html.md +14 -0
  123. data/doc_out/CommandStatus.html.md +20 -0
  124. data/doc_out/CommandStatusEntityListing.html.md +22 -0
  125. data/doc_out/CommonAuditRequest.html.md +19 -0
  126. data/doc_out/ComposerTemplate.html.md +22 -0
  127. data/doc_out/Condition.html.md +19 -0
  128. data/doc_out/ConfigurationApi.html.md +232 -0
  129. data/doc_out/ConnectRate.html.md +15 -0
  130. data/doc_out/ConsultTransfer.html.md +14 -0
  131. data/doc_out/ConsultTransferResponse.html.md +13 -0
  132. data/doc_out/ConsultTransferUpdate.html.md +13 -0
  133. data/doc_out/ConsumedResourcesEntityListing.html.md +22 -0
  134. data/doc_out/ConsumingResourcesEntityListing.html.md +22 -0
  135. data/doc_out/Contact.html.md +16 -0
  136. data/doc_out/ContactAddress.html.md +18 -0
  137. data/doc_out/ContactCallbackRequest.html.md +17 -0
  138. data/doc_out/ContactList.html.md +24 -0
  139. data/doc_out/ContactListEntityListing.html.md +22 -0
  140. data/doc_out/ContactListing.html.md +22 -0
  141. data/doc_out/ContactPhoneNumberColumn.html.md +15 -0
  142. data/doc_out/ContactSales.html.md +25 -0
  143. data/doc_out/ContactSalesResponse.html.md +16 -0
  144. data/doc_out/ContactSort.html.md +14 -0
  145. data/doc_out/ContentAttributeFilterItem.html.md +15 -0
  146. data/doc_out/ContentFacetFilterItem.html.md +16 -0
  147. data/doc_out/ContentFilterItem.html.md +16 -0
  148. data/doc_out/ContentManagementApi.html.md +2236 -0
  149. data/doc_out/ContentQueryRequest.html.md +19 -0
  150. data/doc_out/ContentSortItem.html.md +14 -0
  151. data/doc_out/Contract.html.md +18 -0
  152. data/doc_out/ContractJob.html.md +17 -0
  153. data/doc_out/Control.html.md +19 -0
  154. data/doc_out/ControlOptions.html.md +14 -0
  155. data/doc_out/Conversation.html.md +22 -0
  156. data/doc_out/ConversationChat.html.md +23 -0
  157. data/doc_out/ConversationEntityListing.html.md +22 -0
  158. data/doc_out/ConversationQuery.html.md +20 -0
  159. data/doc_out/ConversationsApi.html.md +3374 -0
  160. data/doc_out/CoverSheet.html.md +14 -0
  161. data/doc_out/CreateCallRequest.html.md +21 -0
  162. data/doc_out/CreateCallResponse.html.md +15 -0
  163. data/doc_out/CreateCallbackCommand.html.md +18 -0
  164. data/doc_out/CreateShareRequest.html.md +17 -0
  165. data/doc_out/CreateShareRequestMember.html.md +14 -0
  166. data/doc_out/CreateShareResponse.html.md +23 -0
  167. data/doc_out/CreateTemplateFromScriptRequestData.html.md +17 -0
  168. data/doc_out/CreateUser.html.md +19 -0
  169. data/doc_out/CsvSchema.html.md +19 -0
  170. data/doc_out/Currency.html.md +16 -0
  171. data/doc_out/CustomerAccount.html.md +21 -0
  172. data/doc_out/DID.html.md +28 -0
  173. data/doc_out/DIDEntityListing.html.md +22 -0
  174. data/doc_out/DIDPool.html.md +28 -0
  175. data/doc_out/DIDPoolEntityListing.html.md +22 -0
  176. data/doc_out/DataItem.html.md +15 -0
  177. data/doc_out/DataValueInfo.html.md +13 -0
  178. data/doc_out/DefaultGreetingList.html.md +22 -0
  179. data/doc_out/DeleteRetention.html.md +13 -0
  180. data/doc_out/DeletedResourceConsumerEntityListing.html.md +22 -0
  181. data/doc_out/DeltaDocument.html.md +19 -0
  182. data/doc_out/DeltaRequest.html.md +13 -0
  183. data/doc_out/DeltaResponse.html.md +15 -0
  184. data/doc_out/Dependency.html.md +18 -0
  185. data/doc_out/DependencyObject.html.md +20 -0
  186. data/doc_out/DependencyObjectEntityListing.html.md +22 -0
  187. data/doc_out/DependencyStatus.html.md +21 -0
  188. data/doc_out/DependencyType.html.md +16 -0
  189. data/doc_out/DependencyTypeEntityListing.html.md +22 -0
  190. data/doc_out/Destination.html.md +16 -0
  191. data/doc_out/Detail.html.md +16 -0
  192. data/doc_out/DiagnosticEmail.html.md +19 -0
  193. data/doc_out/DialerAction.html.md +16 -0
  194. data/doc_out/DialerAuditRequest.html.md +16 -0
  195. data/doc_out/DialerContact.html.md +20 -0
  196. data/doc_out/DialerPreview.html.md +17 -0
  197. data/doc_out/DialerRule.html.md +18 -0
  198. data/doc_out/DigitLength.html.md +14 -0
  199. data/doc_out/DisconnectReason.html.md +15 -0
  200. data/doc_out/Discount.html.md +20 -0
  201. data/doc_out/DncList.html.md +22 -0
  202. data/doc_out/DncListEntityListing.html.md +22 -0
  203. data/doc_out/Dns.html.md +15 -0
  204. data/doc_out/Document.html.md +43 -0
  205. data/doc_out/DocumentAttribute.html.md +14 -0
  206. data/doc_out/DocumentAudit.html.md +28 -0
  207. data/doc_out/DocumentAuditEntityListing.html.md +22 -0
  208. data/doc_out/DocumentEntityListing.html.md +22 -0
  209. data/doc_out/DocumentThumbnail.html.md +14 -0
  210. data/doc_out/DocumentUpdate.html.md +21 -0
  211. data/doc_out/DocumentUpload.html.md +16 -0
  212. data/doc_out/DomainBillingPeriodEntityListing.html.md +22 -0
  213. data/doc_out/DomainCapabilities.html.md +15 -0
  214. data/doc_out/DomainCertificateAuthority.html.md +28 -0
  215. data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +21 -0
  216. data/doc_out/DomainEdgeSoftwareVersionDto.html.md +20 -0
  217. data/doc_out/DomainEntity.html.md +15 -0
  218. data/doc_out/DomainEntityListing.html.md +22 -0
  219. data/doc_out/DomainEntityListingEvaluationForm.html.md +22 -0
  220. data/doc_out/DomainEntityListingQueryResult.html.md +22 -0
  221. data/doc_out/DomainInvoiceEntityListing.html.md +22 -0
  222. data/doc_out/DomainLogicalInterface.html.md +49 -0
  223. data/doc_out/DomainNetworkAddress.html.md +16 -0
  224. data/doc_out/DomainNetworkCommandResponse.html.md +16 -0
  225. data/doc_out/DomainNetworkRoute.html.md +17 -0
  226. data/doc_out/DomainOrgRoleDifference.html.md +17 -0
  227. data/doc_out/DomainOrganizationProduct.html.md +13 -0
  228. data/doc_out/DomainOrganizationRole.html.md +22 -0
  229. data/doc_out/DomainPermission.html.md +17 -0
  230. data/doc_out/DomainPermissionCollection.html.md +17 -0
  231. data/doc_out/DomainPermissionPolicy.html.md +20 -0
  232. data/doc_out/DomainPhysicalCapabilities.html.md +14 -0
  233. data/doc_out/DomainPhysicalInterface.html.md +20 -0
  234. data/doc_out/DomainResourceConditionNode.html.md +17 -0
  235. data/doc_out/DomainResourceConditionValue.html.md +16 -0
  236. data/doc_out/DomainRole.html.md +14 -0
  237. data/doc_out/DomainSchemaReference.html.md +15 -0
  238. data/doc_out/DomainThirdPartyAccountEntityListing.html.md +22 -0
  239. data/doc_out/DomainThirdPartySubscriptionEntityListing.html.md +22 -0
  240. data/doc_out/DomainVoiceRateExtendedResponseItemEntityListing.html.md +22 -0
  241. data/doc_out/DomainVoiceRateInternationalResponseItemEntityListing.html.md +22 -0
  242. data/doc_out/DomainVoiceRateResponseItemEntityListing.html.md +22 -0
  243. data/doc_out/DownloadResponse.html.md +14 -0
  244. data/doc_out/DurationCondition.html.md +15 -0
  245. data/doc_out/Edge.html.md +47 -0
  246. data/doc_out/EdgeAutoUpdateConfig.html.md +16 -0
  247. data/doc_out/EdgeEntityListing.html.md +22 -0
  248. data/doc_out/EdgeGroup.html.md +28 -0
  249. data/doc_out/EdgeGroupEntityListing.html.md +22 -0
  250. data/doc_out/EdgeInterface.html.md +20 -0
  251. data/doc_out/EdgeLine.html.md +23 -0
  252. data/doc_out/EdgeLineEntityListing.html.md +22 -0
  253. data/doc_out/EdgeLogsJob.html.md +16 -0
  254. data/doc_out/EdgeLogsJobFile.html.md +21 -0
  255. data/doc_out/EdgeLogsJobRequest.html.md +15 -0
  256. data/doc_out/EdgeLogsJobResponse.html.md +15 -0
  257. data/doc_out/EdgeLogsJobUploadRequest.html.md +13 -0
  258. data/doc_out/EdgeVersionInformation.html.md +13 -0
  259. data/doc_out/EdgeVersionReport.html.md +14 -0
  260. data/doc_out/Email.html.md +25 -0
  261. data/doc_out/EmailAddress.html.md +14 -0
  262. data/doc_out/EmailAttachment.html.md +17 -0
  263. data/doc_out/EmailConversation.html.md +17 -0
  264. data/doc_out/EmailConversationEntityListing.html.md +22 -0
  265. data/doc_out/EmailMediaParticipant.html.md +35 -0
  266. data/doc_out/EmailMessage.html.md +24 -0
  267. data/doc_out/EmailMessageListing.html.md +22 -0
  268. data/doc_out/EmailSetup.html.md +13 -0
  269. data/doc_out/EmbeddedSignatureView.html.md +13 -0
  270. data/doc_out/EncryptionKey.html.md +18 -0
  271. data/doc_out/EncryptionKeyEntityListing.html.md +22 -0
  272. data/doc_out/Endpoint.html.md +30 -0
  273. data/doc_out/EndpointEntityListing.html.md +22 -0
  274. data/doc_out/Entity.html.md +16 -0
  275. data/doc_out/Entry.html.md +14 -0
  276. data/doc_out/ErrorBody.html.md +22 -0
  277. data/doc_out/ErrorDetails.html.md +20 -0
  278. data/doc_out/EstimatedWaitTimePredictions.html.md +13 -0
  279. data/doc_out/Evaluation.html.md +31 -0
  280. data/doc_out/EvaluationAssignment.html.md +14 -0
  281. data/doc_out/EvaluationEntityListing.html.md +22 -0
  282. data/doc_out/EvaluationForm.html.md +21 -0
  283. data/doc_out/EvaluationFormAndScoringSet.html.md +14 -0
  284. data/doc_out/EvaluationFormEntityListing.html.md +22 -0
  285. data/doc_out/EvaluationScoringSet.html.md +18 -0
  286. data/doc_out/EvaluatorActivity.html.md +22 -0
  287. data/doc_out/EvaluatorActivityEntityListing.html.md +22 -0
  288. data/doc_out/ExpansionCriterium.html.md +14 -0
  289. data/doc_out/ExpressionResponse.html.md +23 -0
  290. data/doc_out/Extension.html.md +28 -0
  291. data/doc_out/ExtensionEntityListing.html.md +22 -0
  292. data/doc_out/ExtensionPool.html.md +26 -0
  293. data/doc_out/ExtensionPoolEntityListing.html.md +22 -0
  294. data/doc_out/ExternalContact.html.md +30 -0
  295. data/doc_out/ExternalContactsApi.html.md +1594 -0
  296. data/doc_out/ExternalOrganization.html.md +28 -0
  297. data/doc_out/ExternalOrganizationListing.html.md +22 -0
  298. data/doc_out/FacetEntry.html.md +20 -0
  299. data/doc_out/FacetInfo.html.md +14 -0
  300. data/doc_out/FacetKeyAttribute.html.md +15 -0
  301. data/doc_out/FacetRequest.html.md +19 -0
  302. data/doc_out/FacetResult.html.md +17 -0
  303. data/doc_out/FacetResultItem.html.md +19 -0
  304. data/doc_out/FacetStatistics.html.md +19 -0
  305. data/doc_out/FacetTerm.html.md +18 -0
  306. data/doc_out/FailedObject.html.md +16 -0
  307. data/doc_out/FavoriteTemplateRequestData.html.md +13 -0
  308. data/doc_out/FaxApi.html.md +354 -0
  309. data/doc_out/FaxDocument.html.md +30 -0
  310. data/doc_out/FaxDocumentEntityListing.html.md +22 -0
  311. data/doc_out/FaxSendRequest.html.md +20 -0
  312. data/doc_out/FaxSendResponse.html.md +17 -0
  313. data/doc_out/FaxSummary.html.md +15 -0
  314. data/doc_out/FilterItem.html.md +17 -0
  315. data/doc_out/Flow.html.md +24 -0
  316. data/doc_out/FlowBody.html.md +14 -0
  317. data/doc_out/FlowBodyFormat.html.md +14 -0
  318. data/doc_out/FlowConfigId.html.md +16 -0
  319. data/doc_out/FlowConfigMetaData.html.md +23 -0
  320. data/doc_out/FlowConfigMetaDataEntityListing.html.md +22 -0
  321. data/doc_out/FlowDetails.html.md +24 -0
  322. data/doc_out/FlowDetailsSearchResult.html.md +14 -0
  323. data/doc_out/FlowEntityListing.html.md +22 -0
  324. data/doc_out/FlowExecId.html.md +15 -0
  325. data/doc_out/FlowHistoryItem.html.md +20 -0
  326. data/doc_out/FlowHistoryResultItem.html.md +15 -0
  327. data/doc_out/FlowHistoryResultItemEntityListing.html.md +22 -0
  328. data/doc_out/FlowInputData.html.md +13 -0
  329. data/doc_out/FlowLaunchRequest.html.md +16 -0
  330. data/doc_out/FlowPublish.html.md +17 -0
  331. data/doc_out/FlowReportResultItem.html.md +24 -0
  332. data/doc_out/FlowSearchRequest.html.md +19 -0
  333. data/doc_out/FlowState.html.md +15 -0
  334. data/doc_out/FlowTerminateRequest.html.md +13 -0
  335. data/doc_out/FlowUploadResponse.html.md +14 -0
  336. data/doc_out/FlowVersion.html.md +23 -0
  337. data/doc_out/FlowVersionConfigMetaData.html.md +20 -0
  338. data/doc_out/FlowVersionConfigMetaDataEntityListing.html.md +22 -0
  339. data/doc_out/FlowVersionEntityListing.html.md +22 -0
  340. data/doc_out/Form.html.md +13 -0
  341. data/doc_out/Gateway.html.md +15 -0
  342. data/doc_out/Geolocation.html.md +22 -0
  343. data/doc_out/GeolocationApi.html.md +245 -0
  344. data/doc_out/GeolocationSettings.html.md +16 -0
  345. data/doc_out/Gistener.html.md +25 -0
  346. data/doc_out/Greeting.html.md +24 -0
  347. data/doc_out/GreetingAudioFile.html.md +15 -0
  348. data/doc_out/GreetingMediaInfo.html.md +15 -0
  349. data/doc_out/GreetingOwner.html.md +15 -0
  350. data/doc_out/GreetingsApi.html.md +712 -0
  351. data/doc_out/Group.html.md +22 -0
  352. data/doc_out/GroupEntityListing.html.md +22 -0
  353. data/doc_out/GroupTag.html.md +19 -0
  354. data/doc_out/GroupsApi.html.md +314 -0
  355. data/doc_out/GroupsSearchResponse.html.md +21 -0
  356. data/doc_out/HIPAAConfig.html.md +16 -0
  357. data/doc_out/HardwareRate.html.md +18 -0
  358. data/doc_out/HardwareRateListing.html.md +22 -0
  359. data/doc_out/HealthCheckInfo.html.md +21 -0
  360. data/doc_out/IVR.html.md +31 -0
  361. data/doc_out/IVREntityListing.html.md +22 -0
  362. data/doc_out/ImportStatus.html.md +17 -0
  363. data/doc_out/InboundDomain.html.md +17 -0
  364. data/doc_out/InboundDomainEntityListing.html.md +22 -0
  365. data/doc_out/InboundRoute.html.md +22 -0
  366. data/doc_out/InboundRouteEntityListing.html.md +22 -0
  367. data/doc_out/IndexedTransform.html.md +16 -0
  368. data/doc_out/IntegrationType.html.md +18 -0
  369. data/doc_out/IntegrationTypeEntityListing.html.md +22 -0
  370. data/doc_out/InteractionStatsAlert.html.md +29 -0
  371. data/doc_out/InteractionStatsAlertContainer.html.md +22 -0
  372. data/doc_out/InteractionStatsRule.html.md +26 -0
  373. data/doc_out/InteractionStatsRuleContainer.html.md +22 -0
  374. data/doc_out/Invoice.html.md +21 -0
  375. data/doc_out/JsonNode.html.md +33 -0
  376. data/doc_out/JsonNodeSearchResponse.html.md +21 -0
  377. data/doc_out/KeyRotationSchedule.html.md +16 -0
  378. data/doc_out/Language.html.md +18 -0
  379. data/doc_out/LanguageEntityListing.html.md +22 -0
  380. data/doc_out/LanguagesApi.html.md +306 -0
  381. data/doc_out/Library.html.md +18 -0
  382. data/doc_out/LibraryEntityListing.html.md +22 -0
  383. data/doc_out/License.html.md +14 -0
  384. data/doc_out/LicensesByPermission.html.md +15 -0
  385. data/doc_out/Line.html.md +32 -0
  386. data/doc_out/LineBase.html.md +17 -0
  387. data/doc_out/LineBaseEntityListing.html.md +22 -0
  388. data/doc_out/LineEntityListing.html.md +22 -0
  389. data/doc_out/LineStatus.html.md +17 -0
  390. data/doc_out/LinkedEntityListingFlowDetails.html.md +22 -0
  391. data/doc_out/LinkedEntityListingWorkItemSearchDetails.html.md +22 -0
  392. data/doc_out/Location.html.md +24 -0
  393. data/doc_out/LocationAddressFields.html.md +19 -0
  394. data/doc_out/LocationEmergencyNumber.html.md +15 -0
  395. data/doc_out/LocationEntityListing.html.md +22 -0
  396. data/doc_out/LocationsApi.html.md +133 -0
  397. data/doc_out/LockInfo.html.md +16 -0
  398. data/doc_out/LogicalInterfaceEntityListing.html.md +22 -0
  399. data/doc_out/ManagementUnit.html.md +18 -0
  400. data/doc_out/ManagementUnitTimezone.html.md +13 -0
  401. data/doc_out/MaxParticipants.html.md +13 -0
  402. data/doc_out/MediaParticipantRequest.html.md +19 -0
  403. data/doc_out/MediaPolicies.html.md +15 -0
  404. data/doc_out/MediaPolicy.html.md +14 -0
  405. data/doc_out/MediaResult.html.md +14 -0
  406. data/doc_out/MediaSetting.html.md +14 -0
  407. data/doc_out/MediaSummary.html.md +14 -0
  408. data/doc_out/MediaSummaryDetail.html.md +14 -0
  409. data/doc_out/MemberEntity.html.md +13 -0
  410. data/doc_out/Metabase.html.md +16 -0
  411. data/doc_out/MeteredEvaluationAssignment.html.md +18 -0
  412. data/doc_out/NocSupport.html.md +14 -0
  413. data/doc_out/Note.html.md +18 -0
  414. data/doc_out/NoteListing.html.md +22 -0
  415. data/doc_out/NotificationsApi.html.md +408 -0
  416. data/doc_out/Number.html.md +14 -0
  417. data/doc_out/NumberOrderRequest.html.md +17 -0
  418. data/doc_out/NumberPlan.html.md +31 -0
  419. data/doc_out/NumericRange.html.md +16 -0
  420. data/doc_out/OAuthApi.html.md +1192 -0
  421. data/doc_out/OAuthClient.html.md +21 -0
  422. data/doc_out/OAuthClientEntityListing.html.md +22 -0
  423. data/doc_out/OAuthProvider.html.md +15 -0
  424. data/doc_out/OAuthProviderEntityListing.html.md +22 -0
  425. data/doc_out/ObservationDataContainer.html.md +14 -0
  426. data/doc_out/ObservationQuery.html.md +14 -0
  427. data/doc_out/ObservationQueryResponse.html.md +13 -0
  428. data/doc_out/Okta.html.md +18 -0
  429. data/doc_out/OneLogin.html.md +18 -0
  430. data/doc_out/Order.html.md +17 -0
  431. data/doc_out/OrgLicenseAssignment.html.md +16 -0
  432. data/doc_out/OrgMediaUtilization.html.md +14 -0
  433. data/doc_out/Organization.html.md +23 -0
  434. data/doc_out/OrganizationApi.html.md +172 -0
  435. data/doc_out/OrganizationCreate.html.md +18 -0
  436. data/doc_out/OrganizationPresence.html.md +22 -0
  437. data/doc_out/OrganizationPresenceEntityListing.html.md +22 -0
  438. data/doc_out/OrganizationProductEntityListing.html.md +17 -0
  439. data/doc_out/OrganizationRoleEntityListing.html.md +22 -0
  440. data/doc_out/OrphanRecording.html.md +23 -0
  441. data/doc_out/OrphanRecordingListing.html.md +22 -0
  442. data/doc_out/OutOfOffice.html.md +19 -0
  443. data/doc_out/OutboundApi.html.md +3780 -0
  444. data/doc_out/OutboundRoute.html.md +30 -0
  445. data/doc_out/OutboundRouteEntityListing.html.md +22 -0
  446. data/doc_out/PINConfiguration.html.md +14 -0
  447. data/doc_out/Page.html.md +20 -0
  448. data/doc_out/PagingSpec.html.md +14 -0
  449. data/doc_out/Parameter.html.md +16 -0
  450. data/doc_out/ParsedCertificate.html.md +13 -0
  451. data/doc_out/Participant.html.md +44 -0
  452. data/doc_out/ParticipantAttributes.html.md +13 -0
  453. data/doc_out/PaymentMethod.html.md +18 -0
  454. data/doc_out/PaymentMethodListing.html.md +22 -0
  455. data/doc_out/PaymentTokenProvider.html.md +16 -0
  456. data/doc_out/PermissionCollectionEntityListing.html.md +22 -0
  457. data/doc_out/Permissions.html.md +15 -0
  458. data/doc_out/Phone.html.md +34 -0
  459. data/doc_out/PhoneBase.html.md +19 -0
  460. data/doc_out/PhoneBaseEntityListing.html.md +22 -0
  461. data/doc_out/PhoneCapabilities.html.md +18 -0
  462. data/doc_out/PhoneColumn.html.md +14 -0
  463. data/doc_out/PhoneEntityListing.html.md +22 -0
  464. data/doc_out/PhoneMetaBaseEntityListing.html.md +22 -0
  465. data/doc_out/PhoneNumber.html.md +18 -0
  466. data/doc_out/PhoneNumberColumn.html.md +14 -0
  467. data/doc_out/PhoneNumberStatus.html.md +13 -0
  468. data/doc_out/PhoneStatus.html.md +21 -0
  469. data/doc_out/PhonesReboot.html.md +14 -0
  470. data/doc_out/PhysicalInterfaceEntityListing.html.md +22 -0
  471. data/doc_out/Policy.html.md +24 -0
  472. data/doc_out/PolicyActions.html.md +18 -0
  473. data/doc_out/PolicyConditions.html.md +20 -0
  474. data/doc_out/PolicyEntityListing.html.md +22 -0
  475. data/doc_out/PolicyErrorMessage.html.md +19 -0
  476. data/doc_out/PolicyErrors.html.md +13 -0
  477. data/doc_out/PredictionResults.html.md +14 -0
  478. data/doc_out/PresenceApi.html.md +427 -0
  479. data/doc_out/PresenceQueryResponse.html.md +14 -0
  480. data/doc_out/Product.html.md +17 -0
  481. data/doc_out/Prompt.html.md +17 -0
  482. data/doc_out/PromptAsset.html.md +24 -0
  483. data/doc_out/PromptAssetEntityListing.html.md +22 -0
  484. data/doc_out/PromptEntityListing.html.md +22 -0
  485. data/doc_out/PropertyIndexRequest.html.md +15 -0
  486. data/doc_out/ProvisionInfo.html.md +15 -0
  487. data/doc_out/Publication.html.md +20 -0
  488. data/doc_out/PublishScriptRequestData.html.md +14 -0
  489. data/doc_out/PublishedResult.html.md +18 -0
  490. data/doc_out/PureCloud.html.md +15 -0
  491. data/doc_out/QualityApi.html.md +1569 -0
  492. data/doc_out/QualityAudit.html.md +23 -0
  493. data/doc_out/QualityAuditPage.html.md +22 -0
  494. data/doc_out/QueryFacetInfo.html.md +14 -0
  495. data/doc_out/QueryRequest.html.md +19 -0
  496. data/doc_out/QueryResult.html.md +16 -0
  497. data/doc_out/QueryResults.html.md +14 -0
  498. data/doc_out/QuestionGroup.html.md +21 -0
  499. data/doc_out/QuestionGroupScore.html.md +23 -0
  500. data/doc_out/QuestionScore.html.md +18 -0
  501. data/doc_out/Queue.html.md +32 -0
  502. data/doc_out/QueueEntityListing.html.md +22 -0
  503. data/doc_out/QueueMember.html.md +20 -0
  504. data/doc_out/QueueUtilizationDiagnostic.html.md +20 -0
  505. data/doc_out/QueuesEntityListing.html.md +22 -0
  506. data/doc_out/Quote.html.md +32 -0
  507. data/doc_out/QuoteCharge.html.md +25 -0
  508. data/doc_out/QuoteListing.html.md +22 -0
  509. data/doc_out/Rate.html.md +17 -0
  510. data/doc_out/Reaction.html.md +15 -0
  511. data/doc_out/Recording.html.md +34 -0
  512. data/doc_out/RecordingApi.html.md +1243 -0
  513. data/doc_out/RecordingEmailMessage.html.md +22 -0
  514. data/doc_out/RecordingSettings.html.md +13 -0
  515. data/doc_out/Relationship.html.md +18 -0
  516. data/doc_out/RelationshipListing.html.md +22 -0
  517. data/doc_out/ReplaceRequest.html.md +15 -0
  518. data/doc_out/ReplaceResponse.html.md +18 -0
  519. data/doc_out/ReportMetaData.html.md +21 -0
  520. data/doc_out/ReportMetaDataEntityListing.html.md +22 -0
  521. data/doc_out/ReportRequest.html.md +18 -0
  522. data/doc_out/ReportRunEntry.html.md +23 -0
  523. data/doc_out/ReportRunEntryEntityDomainListing.html.md +22 -0
  524. data/doc_out/ReportSchedule.html.md +29 -0
  525. data/doc_out/ReportScheduleEntityListing.html.md +22 -0
  526. data/doc_out/Reservation.html.md +16 -0
  527. data/doc_out/ResourceConditionNode.html.md +17 -0
  528. data/doc_out/ResourceConditionValue.html.md +14 -0
  529. data/doc_out/ResourcePermissionPolicy.html.md +22 -0
  530. data/doc_out/Response.html.md +20 -0
  531. data/doc_out/ResponseEntityList.html.md +22 -0
  532. data/doc_out/ResponseEntityListing.html.md +22 -0
  533. data/doc_out/ResponseFilter.html.md +15 -0
  534. data/doc_out/ResponseManagementApi.html.md +657 -0
  535. data/doc_out/ResponseQueryRequest.html.md +15 -0
  536. data/doc_out/ResponseQueryResults.html.md +13 -0
  537. data/doc_out/ResponseSet.html.md +19 -0
  538. data/doc_out/ResponseSetEntityListing.html.md +22 -0
  539. data/doc_out/ResponseText.html.md +14 -0
  540. data/doc_out/RestErrorDetail.html.md +14 -0
  541. data/doc_out/RetentionDuration.html.md +14 -0
  542. data/doc_out/Ring.html.md +14 -0
  543. data/doc_out/RoutingApi.html.md +2388 -0
  544. data/doc_out/RoutingSkill.html.md +19 -0
  545. data/doc_out/RoutingStatus.html.md +15 -0
  546. data/doc_out/RuleSet.html.md +21 -0
  547. data/doc_out/RuleSetEntityListing.html.md +22 -0
  548. data/doc_out/RunNowResponse.html.md +15 -0
  549. data/doc_out/Salesforce.html.md +18 -0
  550. data/doc_out/Schedule.html.md +28 -0
  551. data/doc_out/ScheduleEntityListing.html.md +22 -0
  552. data/doc_out/ScheduleGroup.html.md +27 -0
  553. data/doc_out/ScheduleGroupEntityListing.html.md +22 -0
  554. data/doc_out/SchemaCategory.html.md +15 -0
  555. data/doc_out/SchemaCategoryEntityListing.html.md +22 -0
  556. data/doc_out/SchemaReferenceEntityListing.html.md +22 -0
  557. data/doc_out/Script.html.md +25 -0
  558. data/doc_out/ScriptEntityListing.html.md +22 -0
  559. data/doc_out/SearchAggregation.html.md +15 -0
  560. data/doc_out/SearchApi.html.md +366 -0
  561. data/doc_out/SearchCriteria.html.md +20 -0
  562. data/doc_out/SearchRequest.html.md +21 -0
  563. data/doc_out/SecurityProfile.html.md +16 -0
  564. data/doc_out/SecurityProfileEntityListing.html.md +22 -0
  565. data/doc_out/Segment.html.md +17 -0
  566. data/doc_out/SequenceSchedule.html.md +21 -0
  567. data/doc_out/ServerDate.html.md +13 -0
  568. data/doc_out/Service.html.md +22 -0
  569. data/doc_out/ServiceContext.html.md +13 -0
  570. data/doc_out/ServiceEntityListing.html.md +22 -0
  571. data/doc_out/ServiceLevel.html.md +14 -0
  572. data/doc_out/ServiceType.html.md +19 -0
  573. data/doc_out/Share.html.md +22 -0
  574. data/doc_out/ShareEntityListing.html.md +22 -0
  575. data/doc_out/SharedEntity.html.md +13 -0
  576. data/doc_out/SharedResponse.html.md +17 -0
  577. data/doc_out/SheetSchema.html.md +18 -0
  578. data/doc_out/SheetTransform.html.md +15 -0
  579. data/doc_out/SignatureDocumentInfo.html.md +15 -0
  580. data/doc_out/Site.html.md +33 -0
  581. data/doc_out/SiteEntityListing.html.md +22 -0
  582. data/doc_out/SkillEntityListing.html.md +22 -0
  583. data/doc_out/SkillsToRemove.html.md +15 -0
  584. data/doc_out/Snapshot.html.md +15 -0
  585. data/doc_out/SocialAccount.html.md +24 -0
  586. data/doc_out/SocialConversation.html.md +17 -0
  587. data/doc_out/SocialConversationEntityListing.html.md +22 -0
  588. data/doc_out/SocialExpression.html.md +25 -0
  589. data/doc_out/SocialMediaParticipant.html.md +37 -0
  590. data/doc_out/SocializeEntityFilter.html.md +15 -0
  591. data/doc_out/SocializeFilterRequest.html.md +17 -0
  592. data/doc_out/SortBy.html.md +14 -0
  593. data/doc_out/SortField.html.md +14 -0
  594. data/doc_out/SortItem.html.md +14 -0
  595. data/doc_out/SpreadsheetTransform.html.md +21 -0
  596. data/doc_out/SpreadsheetTransformEntityListing.html.md +22 -0
  597. data/doc_out/Station.html.md +21 -0
  598. data/doc_out/StationEntityListing.html.md +22 -0
  599. data/doc_out/StationsApi.html.md +190 -0
  600. data/doc_out/StatisticalResponse.html.md +14 -0
  601. data/doc_out/StatisticalSummary.html.md +21 -0
  602. data/doc_out/SubDataItem.html.md +17 -0
  603. data/doc_out/SubscriberResponse.html.md +14 -0
  604. data/doc_out/Support.html.md +15 -0
  605. data/doc_out/SystemPrompt.html.md +17 -0
  606. data/doc_out/SystemPromptAsset.html.md +25 -0
  607. data/doc_out/SystemPromptAssetEntityListing.html.md +22 -0
  608. data/doc_out/SystemPromptEntityListing.html.md +22 -0
  609. data/doc_out/TableTransform.html.md +18 -0
  610. data/doc_out/TagModel.html.md +14 -0
  611. data/doc_out/TagQueryRequest.html.md +15 -0
  612. data/doc_out/TagValue.html.md +17 -0
  613. data/doc_out/TagValueEntityListing.html.md +22 -0
  614. data/doc_out/TelephonyProvidersEdgeApi.html.md +6283 -0
  615. data/doc_out/TemplateEntityListing.html.md +22 -0
  616. data/doc_out/TermAttribute.html.md +15 -0
  617. data/doc_out/TextTableTransform.html.md +21 -0
  618. data/doc_out/TextTableTransformEntityListing.html.md +22 -0
  619. data/doc_out/ThirdPartyAccount.html.md +19 -0
  620. data/doc_out/ThirdPartySubscription.html.md +18 -0
  621. data/doc_out/Ticker.html.md +14 -0
  622. data/doc_out/Tier.html.md +14 -0
  623. data/doc_out/TimeAllowed.html.md +15 -0
  624. data/doc_out/TimeInterval.html.md +14 -0
  625. data/doc_out/TimeSlot.html.md +15 -0
  626. data/doc_out/TimeZone.html.md +16 -0
  627. data/doc_out/TimeZoneEntityListing.html.md +22 -0
  628. data/doc_out/TokensApi.html.md +63 -0
  629. data/doc_out/Trace.html.md +19 -0
  630. data/doc_out/TraceList.html.md +14 -0
  631. data/doc_out/TransferRequest.html.md +17 -0
  632. data/doc_out/TransformEndpoint.html.md +24 -0
  633. data/doc_out/TransformLens.html.md +14 -0
  634. data/doc_out/TrunkBase.html.md +28 -0
  635. data/doc_out/TrunkBaseAssignment.html.md +14 -0
  636. data/doc_out/TrunkMetabaseEntityListing.html.md +22 -0
  637. data/doc_out/TwitterExpression.html.md +36 -0
  638. data/doc_out/TwitterExpressionBuffer.html.md +13 -0
  639. data/doc_out/UnpivotColumns.html.md +13 -0
  640. data/doc_out/UnreadMetric.html.md +13 -0
  641. data/doc_out/UnreadStatus.html.md +13 -0
  642. data/doc_out/UploadProgress.html.md +19 -0
  643. data/doc_out/UriReference.html.md +15 -0
  644. data/doc_out/UrlResponse.html.md +13 -0
  645. data/doc_out/User.html.md +32 -0
  646. data/doc_out/UserActionCategory.html.md +15 -0
  647. data/doc_out/UserActionCategoryEntityListing.html.md +22 -0
  648. data/doc_out/UserActionMetadata.html.md +22 -0
  649. data/doc_out/UserActionMetadataEntityListing.html.md +20 -0
  650. data/doc_out/UserActionMetadataRequest.html.md +18 -0
  651. data/doc_out/UserAuthorization.html.md +15 -0
  652. data/doc_out/UserConversationSummary.html.md +19 -0
  653. data/doc_out/UserEntityListing.html.md +22 -0
  654. data/doc_out/UserImage.html.md +14 -0
  655. data/doc_out/UserLicenseAssignment.html.md +17 -0
  656. data/doc_out/UserMe.html.md +33 -0
  657. data/doc_out/UserParam.html.md +14 -0
  658. data/doc_out/UserPresence.html.md +19 -0
  659. data/doc_out/UserQueue.html.md +33 -0
  660. data/doc_out/UserQueueEntityListing.html.md +22 -0
  661. data/doc_out/UserRecording.html.md +25 -0
  662. data/doc_out/UserRecordingEntityListing.html.md +22 -0
  663. data/doc_out/UserRecordingsApi.html.md +366 -0
  664. data/doc_out/UserRoutingSkill.html.md +18 -0
  665. data/doc_out/UserSkillEntityListing.html.md +22 -0
  666. data/doc_out/UserStation.html.md +16 -0
  667. data/doc_out/UserStations.html.md +16 -0
  668. data/doc_out/UsersApi.html.md +2104 -0
  669. data/doc_out/UsersEntityListing.html.md +22 -0
  670. data/doc_out/UsersSearchResponse.html.md +21 -0
  671. data/doc_out/UtilitiesApi.html.md +181 -0
  672. data/doc_out/Utilization.html.md +13 -0
  673. data/doc_out/ValidateAddressRequest.html.md +13 -0
  674. data/doc_out/ValidateAddressResponse.html.md +14 -0
  675. data/doc_out/Value.html.md +19 -0
  676. data/doc_out/VendorConnectionRequest.html.md +15 -0
  677. data/doc_out/Video.html.md +22 -0
  678. data/doc_out/VideoConversation.html.md +17 -0
  679. data/doc_out/VideoConversationEntityListing.html.md +22 -0
  680. data/doc_out/VideoMediaParticipant.html.md +38 -0
  681. data/doc_out/View.html.md +13 -0
  682. data/doc_out/VoiceRate.html.md +22 -0
  683. data/doc_out/VoiceRateExtended.html.md +31 -0
  684. data/doc_out/VoiceRateInternational.html.md +24 -0
  685. data/doc_out/VoiceRateInternationalEntityListing.html.md +22 -0
  686. data/doc_out/VoiceRateUpdate.html.md +25 -0
  687. data/doc_out/VoiceRatesCsv.html.md +16 -0
  688. data/doc_out/VoiceXmlOperation.html.md +24 -0
  689. data/doc_out/VoiceXmlOperationEntityListing.html.md +22 -0
  690. data/doc_out/VoicemailApi.html.md +627 -0
  691. data/doc_out/VoicemailMailboxInfo.html.md +18 -0
  692. data/doc_out/VoicemailMediaInfo.html.md +15 -0
  693. data/doc_out/VoicemailMessage.html.md +23 -0
  694. data/doc_out/VoicemailMessageEntityListing.html.md +22 -0
  695. data/doc_out/VoicemailOrganizationPolicy.html.md +27 -0
  696. data/doc_out/VoicemailUserPolicy.html.md +23 -0
  697. data/doc_out/Vpn.html.md +15 -0
  698. data/doc_out/WorkItem.html.md +15 -0
  699. data/doc_out/WorkItemActions.html.md +13 -0
  700. data/doc_out/WorkItemCache.html.md +17 -0
  701. data/doc_out/WorkItemCommand.html.md +14 -0
  702. data/doc_out/WorkItemCommandGroup.html.md +15 -0
  703. data/doc_out/WorkItemDefinition.html.md +16 -0
  704. data/doc_out/WorkItemDetails.html.md +32 -0
  705. data/doc_out/WorkItemSearchDetails.html.md +13 -0
  706. data/doc_out/WorkItemSearchDetailsSearchResult.html.md +14 -0
  707. data/doc_out/WorkItemSubmitRequest.html.md +14 -0
  708. data/doc_out/WorkItemTransferRequest.html.md +14 -0
  709. data/doc_out/Workspace.html.md +23 -0
  710. data/doc_out/WorkspaceCreate.html.md +14 -0
  711. data/doc_out/WorkspaceEntityListing.html.md +22 -0
  712. data/doc_out/WorkspaceMember.html.md +21 -0
  713. data/doc_out/WorkspaceMemberEntityListing.html.md +22 -0
  714. data/doc_out/WorkspaceSummary.html.md +13 -0
  715. data/doc_out/WrapUpCodeMapping.html.md +20 -0
  716. data/doc_out/Wrapup.html.md +19 -0
  717. data/doc_out/WrapupCode.html.md +19 -0
  718. data/doc_out/WrapupCodeEntityListing.html.md +22 -0
  719. data/doc_out/XlsxSchema.html.md +15 -0
  720. data/doc_out/index.html.md +56 -0
  721. data/external/swagger-codegen-cli.jar +0 -0
  722. data/git_push.sh +52 -0
  723. data/lib/purecloud.rb +679 -664
  724. data/lib/purecloud/api/alerting_api.rb +157 -155
  725. data/lib/purecloud/api/analytics_api.rb +384 -393
  726. data/lib/purecloud/api/attributes_api.rb +115 -109
  727. data/lib/purecloud/api/authorization_api.rb +322 -327
  728. data/lib/purecloud/api/configuration_api.rb +46 -38
  729. data/lib/purecloud/api/content_management_api.rb +739 -763
  730. data/lib/purecloud/api/conversations_api.rb +1082 -1126
  731. data/lib/purecloud/api/external_contacts_api.rb +522 -536
  732. data/lib/purecloud/api/fax_api.rb +110 -104
  733. data/lib/purecloud/api/geolocation_api.rb +61 -53
  734. data/lib/purecloud/api/greetings_api.rb +216 -216
  735. data/lib/purecloud/api/groups_api.rb +121 -114
  736. data/lib/purecloud/api/languages_api.rb +99 -92
  737. data/lib/purecloud/api/locations_api.rb +59 -49
  738. data/lib/purecloud/api/notifications_api.rb +97 -92
  739. data/lib/purecloud/api/o_auth_api.rb +330 -340
  740. data/lib/purecloud/api/organization_api.rb +53 -44
  741. data/lib/purecloud/api/outbound_api.rb +1259 -1310
  742. data/lib/purecloud/api/presence_api.rb +152 -147
  743. data/lib/purecloud/api/quality_api.rb +624 -636
  744. data/lib/purecloud/api/recording_api.rb +396 -404
  745. data/lib/purecloud/api/response_management_api.rb +200 -199
  746. data/lib/purecloud/api/routing_api.rb +721 -749
  747. data/lib/purecloud/api/search_api.rb +74 -68
  748. data/lib/purecloud/api/stations_api.rb +59 -50
  749. data/lib/purecloud/api/telephony_providers_edge_api.rb +1921 -2014
  750. data/lib/purecloud/api/tokens_api.rb +18 -7
  751. data/lib/purecloud/api/user_recordings_api.rb +129 -123
  752. data/lib/purecloud/api/users_api.rb +618 -641
  753. data/lib/purecloud/api/utilities_api.rb +62 -53
  754. data/lib/purecloud/api/voicemail_api.rb +186 -185
  755. data/lib/purecloud/api_client.rb +48 -14
  756. data/lib/purecloud/api_error.rb +16 -0
  757. data/lib/purecloud/models/account.rb +20 -1
  758. data/lib/purecloud/models/account_manager.rb +20 -1
  759. data/lib/purecloud/models/account_overview.rb +20 -1
  760. data/lib/purecloud/models/account_status.rb +20 -1
  761. data/lib/purecloud/models/actions.rb +20 -1
  762. data/lib/purecloud/models/acw_settings.rb +20 -1
  763. data/lib/purecloud/models/address.rb +20 -1
  764. data/lib/purecloud/models/address_listing.rb +20 -1
  765. data/lib/purecloud/models/agent.rb +20 -1
  766. data/lib/purecloud/models/agent_activity.rb +20 -1
  767. data/lib/purecloud/models/agent_activity_entity_listing.rb +20 -1
  768. data/lib/purecloud/models/agent_evaluator_activity.rb +20 -1
  769. data/lib/purecloud/models/aggregate_data_container.rb +20 -1
  770. data/lib/purecloud/models/aggregate_metric_data.rb +20 -1
  771. data/lib/purecloud/models/aggregate_query_response.rb +20 -1
  772. data/lib/purecloud/models/aggregation_query.rb +20 -1
  773. data/lib/purecloud/models/aggregation_range.rb +20 -1
  774. data/lib/purecloud/models/aggregation_result.rb +20 -1
  775. data/lib/purecloud/models/aggregation_result_entry.rb +20 -1
  776. data/lib/purecloud/models/analytics_conversation.rb +20 -1
  777. data/lib/purecloud/models/analytics_conversation_query_response.rb +20 -1
  778. data/lib/purecloud/models/analytics_conversation_segment.rb +20 -1
  779. data/lib/purecloud/models/analytics_evaluation.rb +20 -1
  780. data/lib/purecloud/models/analytics_participant.rb +20 -1
  781. data/lib/purecloud/models/analytics_property.rb +20 -1
  782. data/lib/purecloud/models/analytics_query_aggregation.rb +20 -1
  783. data/lib/purecloud/models/analytics_query_clause.rb +20 -1
  784. data/lib/purecloud/models/analytics_query_filter.rb +20 -1
  785. data/lib/purecloud/models/analytics_query_predicate.rb +20 -1
  786. data/lib/purecloud/models/analytics_session.rb +20 -1
  787. data/lib/purecloud/models/annotation.rb +20 -1
  788. data/lib/purecloud/models/app.rb +20 -1
  789. data/lib/purecloud/models/archive_retention.rb +20 -1
  790. data/lib/purecloud/models/associated_document.rb +20 -1
  791. data/lib/purecloud/models/attachment.rb +20 -1
  792. data/lib/purecloud/models/attribute.rb +20 -1
  793. data/lib/purecloud/models/attribute_entity_listing.rb +20 -1
  794. data/lib/purecloud/models/attribute_filter_item.rb +20 -1
  795. data/lib/purecloud/models/attribute_query_request.rb +20 -1
  796. data/lib/purecloud/models/audit_change.rb +20 -1
  797. data/lib/purecloud/models/audit_entity.rb +20 -1
  798. data/lib/purecloud/models/audit_entity_reference.rb +20 -1
  799. data/lib/purecloud/models/audit_facet.rb +20 -1
  800. data/lib/purecloud/models/audit_filter.rb +20 -1
  801. data/lib/purecloud/models/audit_message.rb +20 -1
  802. data/lib/purecloud/models/audit_search_result.rb +20 -1
  803. data/lib/purecloud/models/audit_user.rb +20 -1
  804. data/lib/purecloud/models/automate_queue.rb +21 -2
  805. data/lib/purecloud/models/automate_queue_member.rb +20 -1
  806. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +20 -1
  807. data/lib/purecloud/models/available_additional_service.rb +20 -1
  808. data/lib/purecloud/models/available_additional_service_listing.rb +20 -1
  809. data/lib/purecloud/models/available_topic.rb +21 -2
  810. data/lib/purecloud/models/available_topic_entity_listing.rb +20 -1
  811. data/lib/purecloud/models/backend_flow_available_actions.rb +20 -1
  812. data/lib/purecloud/models/basic_transform.rb +20 -1
  813. data/lib/purecloud/models/batch_command.rb +20 -1
  814. data/lib/purecloud/models/batch_item.rb +20 -1
  815. data/lib/purecloud/models/batch_item_body.rb +20 -1
  816. data/lib/purecloud/models/batch_reply.rb +20 -1
  817. data/lib/purecloud/models/batch_reply_item.rb +20 -1
  818. data/lib/purecloud/models/billing_address.rb +20 -1
  819. data/lib/purecloud/models/billing_period.rb +20 -1
  820. data/lib/purecloud/models/bullseye.rb +20 -1
  821. data/lib/purecloud/models/calibration.rb +20 -1
  822. data/lib/purecloud/models/calibration_assignment.rb +20 -1
  823. data/lib/purecloud/models/calibration_entity_listing.rb +20 -1
  824. data/lib/purecloud/models/call.rb +20 -1
  825. data/lib/purecloud/models/call_command.rb +20 -1
  826. data/lib/purecloud/models/call_conversation.rb +20 -1
  827. data/lib/purecloud/models/call_conversation_entity_listing.rb +20 -1
  828. data/lib/purecloud/models/call_forwarding.rb +20 -1
  829. data/lib/purecloud/models/call_media_participant.rb +20 -1
  830. data/lib/purecloud/models/call_record.rb +20 -1
  831. data/lib/purecloud/models/callable_contacts_diagnostic.rb +20 -1
  832. data/lib/purecloud/models/callable_time.rb +20 -1
  833. data/lib/purecloud/models/callable_time_set.rb +20 -1
  834. data/lib/purecloud/models/callable_time_set_entity_listing.rb +20 -1
  835. data/lib/purecloud/models/callback.rb +20 -1
  836. data/lib/purecloud/models/callback_conversation.rb +20 -1
  837. data/lib/purecloud/models/callback_conversation_entity_listing.rb +20 -1
  838. data/lib/purecloud/models/callback_media_participant.rb +20 -1
  839. data/lib/purecloud/models/campaign.rb +20 -1
  840. data/lib/purecloud/models/campaign_diagnostics.rb +20 -1
  841. data/lib/purecloud/models/campaign_entity_listing.rb +20 -1
  842. data/lib/purecloud/models/campaign_progress.rb +20 -1
  843. data/lib/purecloud/models/campaign_schedule.rb +21 -2
  844. data/lib/purecloud/models/campaign_schedule_intervals.rb +20 -1
  845. data/lib/purecloud/models/campaign_sequence.rb +20 -1
  846. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +20 -1
  847. data/lib/purecloud/models/campaign_stats.rb +20 -1
  848. data/lib/purecloud/models/campaign_time_slot.rb +20 -1
  849. data/lib/purecloud/models/carrier.rb +20 -1
  850. data/lib/purecloud/models/carrier_address.rb +20 -1
  851. data/lib/purecloud/models/carrier_entity_listing.rb +20 -1
  852. data/lib/purecloud/models/certificate.rb +20 -1
  853. data/lib/purecloud/models/certificate_authority_entity_listing.rb +20 -1
  854. data/lib/purecloud/models/certificate_details.rb +20 -1
  855. data/lib/purecloud/models/change.rb +20 -1
  856. data/lib/purecloud/models/channel.rb +20 -1
  857. data/lib/purecloud/models/channel_entity_listing.rb +20 -1
  858. data/lib/purecloud/models/channel_topic.rb +20 -1
  859. data/lib/purecloud/models/channel_topic_entity_listing.rb +20 -1
  860. data/lib/purecloud/models/charge.rb +20 -1
  861. data/lib/purecloud/models/chat.rb +20 -1
  862. data/lib/purecloud/models/chat_conversation.rb +20 -1
  863. data/lib/purecloud/models/chat_conversation_entity_listing.rb +20 -1
  864. data/lib/purecloud/models/chat_media_participant.rb +20 -1
  865. data/lib/purecloud/models/chat_message.rb +20 -1
  866. data/lib/purecloud/models/chat_message_user.rb +20 -1
  867. data/lib/purecloud/models/client_spreadsheet_transform.rb +20 -1
  868. data/lib/purecloud/models/client_text_table_transform.rb +20 -1
  869. data/lib/purecloud/models/column_collapse.rb +20 -1
  870. data/lib/purecloud/models/command_status.rb +20 -1
  871. data/lib/purecloud/models/command_status_entity_listing.rb +20 -1
  872. data/lib/purecloud/models/common_audit_request.rb +20 -1
  873. data/lib/purecloud/models/composer_template.rb +21 -2
  874. data/lib/purecloud/models/condition.rb +20 -1
  875. data/lib/purecloud/models/connect_rate.rb +20 -1
  876. data/lib/purecloud/models/consult_transfer.rb +20 -1
  877. data/lib/purecloud/models/consult_transfer_response.rb +20 -1
  878. data/lib/purecloud/models/consult_transfer_update.rb +20 -1
  879. data/lib/purecloud/models/consumed_resources_entity_listing.rb +20 -1
  880. data/lib/purecloud/models/consuming_resources_entity_listing.rb +20 -1
  881. data/lib/purecloud/models/contact.rb +20 -1
  882. data/lib/purecloud/models/contact_address.rb +20 -1
  883. data/lib/purecloud/models/contact_callback_request.rb +20 -1
  884. data/lib/purecloud/models/contact_list.rb +20 -1
  885. data/lib/purecloud/models/contact_list_entity_listing.rb +20 -1
  886. data/lib/purecloud/models/contact_listing.rb +20 -1
  887. data/lib/purecloud/models/contact_phone_number_column.rb +20 -1
  888. data/lib/purecloud/models/contact_sales.rb +20 -1
  889. data/lib/purecloud/models/contact_sales_response.rb +20 -1
  890. data/lib/purecloud/models/contact_sort.rb +20 -1
  891. data/lib/purecloud/models/content_attribute_filter_item.rb +20 -1
  892. data/lib/purecloud/models/content_facet_filter_item.rb +20 -1
  893. data/lib/purecloud/models/content_filter_item.rb +20 -1
  894. data/lib/purecloud/models/content_query_request.rb +20 -1
  895. data/lib/purecloud/models/content_sort_item.rb +20 -1
  896. data/lib/purecloud/models/contract.rb +20 -1
  897. data/lib/purecloud/models/contract_job.rb +20 -1
  898. data/lib/purecloud/models/control.rb +20 -1
  899. data/lib/purecloud/models/control_options.rb +20 -1
  900. data/lib/purecloud/models/conversation.rb +20 -1
  901. data/lib/purecloud/models/conversation_chat.rb +20 -1
  902. data/lib/purecloud/models/conversation_entity_listing.rb +20 -1
  903. data/lib/purecloud/models/conversation_query.rb +20 -1
  904. data/lib/purecloud/models/cover_sheet.rb +20 -1
  905. data/lib/purecloud/models/create_call_request.rb +20 -1
  906. data/lib/purecloud/models/create_call_response.rb +20 -1
  907. data/lib/purecloud/models/create_callback_command.rb +20 -1
  908. data/lib/purecloud/models/create_share_request.rb +20 -1
  909. data/lib/purecloud/models/create_share_request_member.rb +20 -1
  910. data/lib/purecloud/models/create_share_response.rb +20 -1
  911. data/lib/purecloud/models/create_template_from_script_request_data.rb +20 -1
  912. data/lib/purecloud/models/create_user.rb +20 -1
  913. data/lib/purecloud/models/csv_schema.rb +20 -1
  914. data/lib/purecloud/models/currency.rb +20 -1
  915. data/lib/purecloud/models/customer_account.rb +20 -1
  916. data/lib/purecloud/models/data_item.rb +20 -1
  917. data/lib/purecloud/models/data_value_info.rb +20 -1
  918. data/lib/purecloud/models/default_greeting_list.rb +20 -1
  919. data/lib/purecloud/models/delete_retention.rb +20 -1
  920. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +20 -1
  921. data/lib/purecloud/models/delta_document.rb +20 -1
  922. data/lib/purecloud/models/delta_request.rb +20 -1
  923. data/lib/purecloud/models/delta_response.rb +20 -1
  924. data/lib/purecloud/models/dependency.rb +20 -1
  925. data/lib/purecloud/models/dependency_object.rb +20 -1
  926. data/lib/purecloud/models/dependency_object_entity_listing.rb +20 -1
  927. data/lib/purecloud/models/dependency_status.rb +20 -1
  928. data/lib/purecloud/models/dependency_type.rb +20 -1
  929. data/lib/purecloud/models/dependency_type_entity_listing.rb +20 -1
  930. data/lib/purecloud/models/destination.rb +20 -1
  931. data/lib/purecloud/models/detail.rb +20 -1
  932. data/lib/purecloud/models/diagnostic_email.rb +20 -1
  933. data/lib/purecloud/models/dialer_action.rb +20 -1
  934. data/lib/purecloud/models/dialer_audit_request.rb +20 -1
  935. data/lib/purecloud/models/dialer_contact.rb +21 -2
  936. data/lib/purecloud/models/dialer_preview.rb +20 -1
  937. data/lib/purecloud/models/dialer_rule.rb +20 -1
  938. data/lib/purecloud/models/did.rb +20 -1
  939. data/lib/purecloud/models/did_entity_listing.rb +20 -1
  940. data/lib/purecloud/models/did_pool.rb +20 -1
  941. data/lib/purecloud/models/did_pool_entity_listing.rb +20 -1
  942. data/lib/purecloud/models/digit_length.rb +20 -1
  943. data/lib/purecloud/models/disconnect_reason.rb +20 -1
  944. data/lib/purecloud/models/discount.rb +20 -1
  945. data/lib/purecloud/models/dnc_list.rb +20 -1
  946. data/lib/purecloud/models/dnc_list_entity_listing.rb +20 -1
  947. data/lib/purecloud/models/dns.rb +20 -1
  948. data/lib/purecloud/models/document.rb +20 -1
  949. data/lib/purecloud/models/document_attribute.rb +20 -1
  950. data/lib/purecloud/models/document_audit.rb +20 -1
  951. data/lib/purecloud/models/document_audit_entity_listing.rb +20 -1
  952. data/lib/purecloud/models/document_entity_listing.rb +20 -1
  953. data/lib/purecloud/models/document_thumbnail.rb +20 -1
  954. data/lib/purecloud/models/document_update.rb +20 -1
  955. data/lib/purecloud/models/document_upload.rb +20 -1
  956. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +20 -1
  957. data/lib/purecloud/models/domain_capabilities.rb +20 -1
  958. data/lib/purecloud/models/domain_certificate_authority.rb +20 -1
  959. data/lib/purecloud/models/domain_edge_software_update_dto.rb +20 -1
  960. data/lib/purecloud/models/domain_edge_software_version_dto.rb +20 -1
  961. data/lib/purecloud/models/domain_entity.rb +20 -1
  962. data/lib/purecloud/models/domain_entity_listing.rb +20 -1
  963. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +20 -1
  964. data/lib/purecloud/models/domain_entity_listing_query_result.rb +20 -1
  965. data/lib/purecloud/models/domain_invoice_entity_listing.rb +20 -1
  966. data/lib/purecloud/models/domain_logical_interface.rb +20 -1
  967. data/lib/purecloud/models/domain_network_address.rb +20 -1
  968. data/lib/purecloud/models/domain_network_command_response.rb +20 -1
  969. data/lib/purecloud/models/domain_network_route.rb +20 -1
  970. data/lib/purecloud/models/domain_org_role_difference.rb +20 -1
  971. data/lib/purecloud/models/domain_organization_product.rb +20 -1
  972. data/lib/purecloud/models/domain_organization_role.rb +20 -1
  973. data/lib/purecloud/models/domain_permission.rb +20 -1
  974. data/lib/purecloud/models/domain_permission_collection.rb +20 -1
  975. data/lib/purecloud/models/domain_permission_policy.rb +20 -1
  976. data/lib/purecloud/models/domain_physical_capabilities.rb +20 -1
  977. data/lib/purecloud/models/domain_physical_interface.rb +20 -1
  978. data/lib/purecloud/models/domain_resource_condition_node.rb +20 -1
  979. data/lib/purecloud/models/domain_resource_condition_value.rb +20 -1
  980. data/lib/purecloud/models/domain_role.rb +20 -1
  981. data/lib/purecloud/models/domain_schema_reference.rb +20 -1
  982. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +20 -1
  983. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +20 -1
  984. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +20 -1
  985. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +20 -1
  986. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +20 -1
  987. data/lib/purecloud/models/download_response.rb +20 -1
  988. data/lib/purecloud/models/duration_condition.rb +20 -1
  989. data/lib/purecloud/models/edge.rb +20 -1
  990. data/lib/purecloud/models/edge_auto_update_config.rb +20 -1
  991. data/lib/purecloud/models/edge_entity_listing.rb +20 -1
  992. data/lib/purecloud/models/edge_group.rb +20 -1
  993. data/lib/purecloud/models/edge_group_entity_listing.rb +20 -1
  994. data/lib/purecloud/models/edge_interface.rb +20 -1
  995. data/lib/purecloud/models/edge_line.rb +21 -2
  996. data/lib/purecloud/models/edge_line_entity_listing.rb +20 -1
  997. data/lib/purecloud/models/edge_logs_job.rb +20 -1
  998. data/lib/purecloud/models/edge_logs_job_file.rb +20 -1
  999. data/lib/purecloud/models/edge_logs_job_request.rb +26 -7
  1000. data/lib/purecloud/models/edge_logs_job_response.rb +20 -1
  1001. data/lib/purecloud/models/edge_logs_job_upload_request.rb +20 -1
  1002. data/lib/purecloud/models/edge_version_information.rb +20 -1
  1003. data/lib/purecloud/models/edge_version_report.rb +20 -1
  1004. data/lib/purecloud/models/email.rb +20 -1
  1005. data/lib/purecloud/models/email_address.rb +20 -1
  1006. data/lib/purecloud/models/email_attachment.rb +20 -1
  1007. data/lib/purecloud/models/email_conversation.rb +20 -1
  1008. data/lib/purecloud/models/email_conversation_entity_listing.rb +20 -1
  1009. data/lib/purecloud/models/email_media_participant.rb +20 -1
  1010. data/lib/purecloud/models/email_message.rb +20 -1
  1011. data/lib/purecloud/models/email_message_listing.rb +20 -1
  1012. data/lib/purecloud/models/email_setup.rb +20 -1
  1013. data/lib/purecloud/models/embedded_signature_view.rb +20 -1
  1014. data/lib/purecloud/models/encryption_key.rb +20 -1
  1015. data/lib/purecloud/models/encryption_key_entity_listing.rb +20 -1
  1016. data/lib/purecloud/models/endpoint.rb +21 -2
  1017. data/lib/purecloud/models/endpoint_entity_listing.rb +20 -1
  1018. data/lib/purecloud/models/entity.rb +20 -1
  1019. data/lib/purecloud/models/entry.rb +20 -1
  1020. data/lib/purecloud/models/error_body.rb +20 -1
  1021. data/lib/purecloud/models/error_details.rb +20 -1
  1022. data/lib/purecloud/models/estimated_wait_time_predictions.rb +20 -1
  1023. data/lib/purecloud/models/evaluation.rb +20 -1
  1024. data/lib/purecloud/models/evaluation_assignment.rb +20 -1
  1025. data/lib/purecloud/models/evaluation_entity_listing.rb +20 -1
  1026. data/lib/purecloud/models/evaluation_form.rb +20 -1
  1027. data/lib/purecloud/models/evaluation_form_and_scoring_set.rb +20 -1
  1028. data/lib/purecloud/models/evaluation_form_entity_listing.rb +20 -1
  1029. data/lib/purecloud/models/evaluation_scoring_set.rb +20 -1
  1030. data/lib/purecloud/models/evaluator_activity.rb +20 -1
  1031. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +20 -1
  1032. data/lib/purecloud/models/expansion_criterium.rb +20 -1
  1033. data/lib/purecloud/models/expression_response.rb +20 -1
  1034. data/lib/purecloud/models/extension.rb +20 -1
  1035. data/lib/purecloud/models/extension_entity_listing.rb +20 -1
  1036. data/lib/purecloud/models/extension_pool.rb +20 -1
  1037. data/lib/purecloud/models/extension_pool_entity_listing.rb +20 -1
  1038. data/lib/purecloud/models/external_contact.rb +20 -1
  1039. data/lib/purecloud/models/external_organization.rb +20 -1
  1040. data/lib/purecloud/models/external_organization_listing.rb +20 -1
  1041. data/lib/purecloud/models/facet_entry.rb +20 -1
  1042. data/lib/purecloud/models/facet_info.rb +20 -1
  1043. data/lib/purecloud/models/facet_key_attribute.rb +20 -1
  1044. data/lib/purecloud/models/facet_request.rb +20 -1
  1045. data/lib/purecloud/models/facet_result.rb +20 -1
  1046. data/lib/purecloud/models/facet_result_item.rb +20 -1
  1047. data/lib/purecloud/models/facet_statistics.rb +20 -1
  1048. data/lib/purecloud/models/facet_term.rb +20 -1
  1049. data/lib/purecloud/models/failed_object.rb +20 -1
  1050. data/lib/purecloud/models/favorite_template_request_data.rb +20 -1
  1051. data/lib/purecloud/models/fax_document.rb +20 -1
  1052. data/lib/purecloud/models/fax_document_entity_listing.rb +20 -1
  1053. data/lib/purecloud/models/fax_send_request.rb +20 -1
  1054. data/lib/purecloud/models/fax_send_response.rb +20 -1
  1055. data/lib/purecloud/models/fax_summary.rb +20 -1
  1056. data/lib/purecloud/models/filter_item.rb +20 -1
  1057. data/lib/purecloud/models/flow.rb +20 -1
  1058. data/lib/purecloud/models/flow_body.rb +21 -2
  1059. data/lib/purecloud/models/flow_body_format.rb +20 -1
  1060. data/lib/purecloud/models/flow_config_id.rb +20 -1
  1061. data/lib/purecloud/models/flow_config_meta_data.rb +20 -1
  1062. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +20 -1
  1063. data/lib/purecloud/models/flow_details.rb +20 -1
  1064. data/lib/purecloud/models/flow_details_search_result.rb +20 -1
  1065. data/lib/purecloud/models/flow_entity_listing.rb +20 -1
  1066. data/lib/purecloud/models/flow_exec_id.rb +20 -1
  1067. data/lib/purecloud/models/flow_history_item.rb +20 -1
  1068. data/lib/purecloud/models/flow_history_result_item.rb +20 -1
  1069. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +20 -1
  1070. data/lib/purecloud/models/flow_input_data.rb +20 -1
  1071. data/lib/purecloud/models/flow_launch_request.rb +20 -1
  1072. data/lib/purecloud/models/flow_publish.rb +20 -1
  1073. data/lib/purecloud/models/flow_report_result_item.rb +20 -1
  1074. data/lib/purecloud/models/flow_search_request.rb +20 -1
  1075. data/lib/purecloud/models/flow_state.rb +20 -1
  1076. data/lib/purecloud/models/flow_terminate_request.rb +20 -1
  1077. data/lib/purecloud/models/flow_upload_response.rb +20 -1
  1078. data/lib/purecloud/models/flow_version.rb +20 -1
  1079. data/lib/purecloud/models/flow_version_config_meta_data.rb +20 -1
  1080. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +20 -1
  1081. data/lib/purecloud/models/flow_version_entity_listing.rb +20 -1
  1082. data/lib/purecloud/models/form.rb +20 -1
  1083. data/lib/purecloud/models/gateway.rb +20 -1
  1084. data/lib/purecloud/models/geolocation.rb +20 -1
  1085. data/lib/purecloud/models/geolocation_settings.rb +20 -1
  1086. data/lib/purecloud/models/gistener.rb +20 -1
  1087. data/lib/purecloud/models/greeting.rb +20 -1
  1088. data/lib/purecloud/models/greeting_audio_file.rb +20 -1
  1089. data/lib/purecloud/models/greeting_media_info.rb +20 -1
  1090. data/lib/purecloud/models/greeting_owner.rb +20 -1
  1091. data/lib/purecloud/models/group.rb +20 -1
  1092. data/lib/purecloud/models/group_entity_listing.rb +20 -1
  1093. data/lib/purecloud/models/group_tag.rb +20 -1
  1094. data/lib/purecloud/models/groups_search_response.rb +20 -1
  1095. data/lib/purecloud/models/hardware_rate.rb +20 -1
  1096. data/lib/purecloud/models/hardware_rate_listing.rb +20 -1
  1097. data/lib/purecloud/models/health_check_info.rb +20 -1
  1098. data/lib/purecloud/models/hipaa_config.rb +20 -1
  1099. data/lib/purecloud/models/import_status.rb +20 -1
  1100. data/lib/purecloud/models/inbound_domain.rb +20 -1
  1101. data/lib/purecloud/models/inbound_domain_entity_listing.rb +20 -1
  1102. data/lib/purecloud/models/inbound_route.rb +20 -1
  1103. data/lib/purecloud/models/inbound_route_entity_listing.rb +20 -1
  1104. data/lib/purecloud/models/indexed_transform.rb +20 -1
  1105. data/lib/purecloud/models/integration_type.rb +20 -1
  1106. data/lib/purecloud/models/integration_type_entity_listing.rb +20 -1
  1107. data/lib/purecloud/models/interaction_stats_alert.rb +20 -1
  1108. data/lib/purecloud/models/interaction_stats_alert_container.rb +20 -1
  1109. data/lib/purecloud/models/interaction_stats_rule.rb +20 -1
  1110. data/lib/purecloud/models/interaction_stats_rule_container.rb +20 -1
  1111. data/lib/purecloud/models/invoice.rb +20 -1
  1112. data/lib/purecloud/models/ivr.rb +20 -1
  1113. data/lib/purecloud/models/ivr_entity_listing.rb +20 -1
  1114. data/lib/purecloud/models/json_node.rb +20 -1
  1115. data/lib/purecloud/models/json_node_search_response.rb +20 -1
  1116. data/lib/purecloud/models/key_rotation_schedule.rb +20 -1
  1117. data/lib/purecloud/models/language.rb +20 -1
  1118. data/lib/purecloud/models/language_entity_listing.rb +20 -1
  1119. data/lib/purecloud/models/library.rb +20 -1
  1120. data/lib/purecloud/models/library_entity_listing.rb +20 -1
  1121. data/lib/purecloud/models/license.rb +20 -1
  1122. data/lib/purecloud/models/licenses_by_permission.rb +20 -1
  1123. data/lib/purecloud/models/line.rb +21 -2
  1124. data/lib/purecloud/models/line_base.rb +21 -2
  1125. data/lib/purecloud/models/line_base_entity_listing.rb +20 -1
  1126. data/lib/purecloud/models/line_entity_listing.rb +20 -1
  1127. data/lib/purecloud/models/line_status.rb +20 -1
  1128. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +20 -1
  1129. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +20 -1
  1130. data/lib/purecloud/models/location.rb +26 -7
  1131. data/lib/purecloud/models/location_address_fields.rb +20 -1
  1132. data/lib/purecloud/models/location_emergency_number.rb +20 -1
  1133. data/lib/purecloud/models/location_entity_listing.rb +20 -1
  1134. data/lib/purecloud/models/lock_info.rb +20 -1
  1135. data/lib/purecloud/models/logical_interface_entity_listing.rb +20 -1
  1136. data/lib/purecloud/models/management_unit.rb +20 -1
  1137. data/lib/purecloud/models/management_unit_timezone.rb +20 -1
  1138. data/lib/purecloud/models/max_participants.rb +20 -1
  1139. data/lib/purecloud/models/media_participant_request.rb +20 -1
  1140. data/lib/purecloud/models/media_policies.rb +20 -1
  1141. data/lib/purecloud/models/media_policy.rb +20 -1
  1142. data/lib/purecloud/models/media_result.rb +20 -1
  1143. data/lib/purecloud/models/media_setting.rb +20 -1
  1144. data/lib/purecloud/models/media_summary.rb +20 -1
  1145. data/lib/purecloud/models/media_summary_detail.rb +20 -1
  1146. data/lib/purecloud/models/member_entity.rb +20 -1
  1147. data/lib/purecloud/models/metabase.rb +20 -1
  1148. data/lib/purecloud/models/metered_evaluation_assignment.rb +20 -1
  1149. data/lib/purecloud/models/noc_support.rb +20 -1
  1150. data/lib/purecloud/models/note.rb +20 -1
  1151. data/lib/purecloud/models/note_listing.rb +20 -1
  1152. data/lib/purecloud/models/number.rb +20 -1
  1153. data/lib/purecloud/models/number_order_request.rb +20 -1
  1154. data/lib/purecloud/models/number_plan.rb +20 -1
  1155. data/lib/purecloud/models/numeric_range.rb +20 -1
  1156. data/lib/purecloud/models/o_auth_client.rb +20 -1
  1157. data/lib/purecloud/models/o_auth_client_entity_listing.rb +20 -1
  1158. data/lib/purecloud/models/o_auth_provider.rb +20 -1
  1159. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +20 -1
  1160. data/lib/purecloud/models/observation_data_container.rb +20 -1
  1161. data/lib/purecloud/models/observation_query.rb +20 -1
  1162. data/lib/purecloud/models/observation_query_response.rb +20 -1
  1163. data/lib/purecloud/models/okta.rb +20 -1
  1164. data/lib/purecloud/models/one_login.rb +20 -1
  1165. data/lib/purecloud/models/order.rb +20 -1
  1166. data/lib/purecloud/models/org_license_assignment.rb +20 -1
  1167. data/lib/purecloud/models/org_media_utilization.rb +20 -1
  1168. data/lib/purecloud/models/organization.rb +20 -1
  1169. data/lib/purecloud/models/organization_create.rb +20 -1
  1170. data/lib/purecloud/models/organization_presence.rb +20 -1
  1171. data/lib/purecloud/models/organization_presence_entity_listing.rb +20 -1
  1172. data/lib/purecloud/models/organization_product_entity_listing.rb +20 -1
  1173. data/lib/purecloud/models/organization_role_entity_listing.rb +20 -1
  1174. data/lib/purecloud/models/orphan_recording.rb +20 -1
  1175. data/lib/purecloud/models/orphan_recording_listing.rb +20 -1
  1176. data/lib/purecloud/models/out_of_office.rb +20 -1
  1177. data/lib/purecloud/models/outbound_route.rb +20 -1
  1178. data/lib/purecloud/models/outbound_route_entity_listing.rb +20 -1
  1179. data/lib/purecloud/models/page.rb +22 -3
  1180. data/lib/purecloud/models/paging_spec.rb +20 -1
  1181. data/lib/purecloud/models/parameter.rb +20 -1
  1182. data/lib/purecloud/models/parsed_certificate.rb +20 -1
  1183. data/lib/purecloud/models/participant.rb +20 -1
  1184. data/lib/purecloud/models/participant_attributes.rb +20 -1
  1185. data/lib/purecloud/models/payment_method.rb +20 -1
  1186. data/lib/purecloud/models/payment_method_listing.rb +20 -1
  1187. data/lib/purecloud/models/payment_token_provider.rb +20 -1
  1188. data/lib/purecloud/models/permission_collection_entity_listing.rb +20 -1
  1189. data/lib/purecloud/models/permissions.rb +20 -1
  1190. data/lib/purecloud/models/phone.rb +21 -2
  1191. data/lib/purecloud/models/phone_base.rb +21 -2
  1192. data/lib/purecloud/models/phone_base_entity_listing.rb +20 -1
  1193. data/lib/purecloud/models/phone_capabilities.rb +20 -1
  1194. data/lib/purecloud/models/phone_column.rb +20 -1
  1195. data/lib/purecloud/models/phone_entity_listing.rb +20 -1
  1196. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +20 -1
  1197. data/lib/purecloud/models/phone_number.rb +20 -1
  1198. data/lib/purecloud/models/phone_number_column.rb +20 -1
  1199. data/lib/purecloud/models/phone_number_status.rb +20 -1
  1200. data/lib/purecloud/models/phone_status.rb +20 -1
  1201. data/lib/purecloud/models/phones_reboot.rb +20 -1
  1202. data/lib/purecloud/models/physical_interface_entity_listing.rb +20 -1
  1203. data/lib/purecloud/models/pin_configuration.rb +20 -1
  1204. data/lib/purecloud/models/policy.rb +20 -1
  1205. data/lib/purecloud/models/policy_actions.rb +20 -1
  1206. data/lib/purecloud/models/policy_conditions.rb +20 -1
  1207. data/lib/purecloud/models/policy_entity_listing.rb +20 -1
  1208. data/lib/purecloud/models/policy_error_message.rb +20 -1
  1209. data/lib/purecloud/models/policy_errors.rb +20 -1
  1210. data/lib/purecloud/models/prediction_results.rb +20 -1
  1211. data/lib/purecloud/models/presence_query_response.rb +20 -1
  1212. data/lib/purecloud/models/product.rb +20 -1
  1213. data/lib/purecloud/models/prompt.rb +20 -1
  1214. data/lib/purecloud/models/prompt_asset.rb +20 -1
  1215. data/lib/purecloud/models/prompt_asset_entity_listing.rb +20 -1
  1216. data/lib/purecloud/models/prompt_entity_listing.rb +20 -1
  1217. data/lib/purecloud/models/property_index_request.rb +20 -1
  1218. data/lib/purecloud/models/provision_info.rb +20 -1
  1219. data/lib/purecloud/models/publication.rb +20 -1
  1220. data/lib/purecloud/models/publish_script_request_data.rb +20 -1
  1221. data/lib/purecloud/models/published_result.rb +20 -1
  1222. data/lib/purecloud/models/pure_cloud.rb +20 -1
  1223. data/lib/purecloud/models/quality_audit.rb +20 -1
  1224. data/lib/purecloud/models/quality_audit_page.rb +20 -1
  1225. data/lib/purecloud/models/query_facet_info.rb +20 -1
  1226. data/lib/purecloud/models/query_request.rb +20 -1
  1227. data/lib/purecloud/models/query_result.rb +20 -1
  1228. data/lib/purecloud/models/query_results.rb +20 -1
  1229. data/lib/purecloud/models/question_group.rb +20 -1
  1230. data/lib/purecloud/models/question_group_score.rb +20 -1
  1231. data/lib/purecloud/models/question_score.rb +20 -1
  1232. data/lib/purecloud/models/queue.rb +20 -1
  1233. data/lib/purecloud/models/queue_entity_listing.rb +20 -1
  1234. data/lib/purecloud/models/queue_member.rb +20 -1
  1235. data/lib/purecloud/models/queue_utilization_diagnostic.rb +20 -1
  1236. data/lib/purecloud/models/queues_entity_listing.rb +20 -1
  1237. data/lib/purecloud/models/quote.rb +20 -1
  1238. data/lib/purecloud/models/quote_charge.rb +20 -1
  1239. data/lib/purecloud/models/quote_listing.rb +20 -1
  1240. data/lib/purecloud/models/rate.rb +20 -1
  1241. data/lib/purecloud/models/reaction.rb +20 -1
  1242. data/lib/purecloud/models/recording.rb +26 -7
  1243. data/lib/purecloud/models/recording_email_message.rb +20 -1
  1244. data/lib/purecloud/models/recording_settings.rb +20 -1
  1245. data/lib/purecloud/models/relationship.rb +20 -1
  1246. data/lib/purecloud/models/relationship_listing.rb +20 -1
  1247. data/lib/purecloud/models/replace_request.rb +20 -1
  1248. data/lib/purecloud/models/replace_response.rb +20 -1
  1249. data/lib/purecloud/models/report_meta_data.rb +20 -1
  1250. data/lib/purecloud/models/report_meta_data_entity_listing.rb +20 -1
  1251. data/lib/purecloud/models/report_request.rb +20 -1
  1252. data/lib/purecloud/models/report_run_entry.rb +20 -1
  1253. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +20 -1
  1254. data/lib/purecloud/models/report_schedule.rb +21 -2
  1255. data/lib/purecloud/models/report_schedule_entity_listing.rb +20 -1
  1256. data/lib/purecloud/models/reservation.rb +20 -1
  1257. data/lib/purecloud/models/resource_condition_node.rb +20 -1
  1258. data/lib/purecloud/models/resource_condition_value.rb +20 -1
  1259. data/lib/purecloud/models/resource_permission_policy.rb +20 -1
  1260. data/lib/purecloud/models/response.rb +20 -1
  1261. data/lib/purecloud/models/response_entity_list.rb +20 -1
  1262. data/lib/purecloud/models/response_entity_listing.rb +20 -1
  1263. data/lib/purecloud/models/response_filter.rb +20 -1
  1264. data/lib/purecloud/models/response_query_request.rb +20 -1
  1265. data/lib/purecloud/models/response_query_results.rb +20 -1
  1266. data/lib/purecloud/models/response_set.rb +20 -1
  1267. data/lib/purecloud/models/response_set_entity_listing.rb +20 -1
  1268. data/lib/purecloud/models/response_text.rb +20 -1
  1269. data/lib/purecloud/models/rest_error_detail.rb +20 -1
  1270. data/lib/purecloud/models/retention_duration.rb +20 -1
  1271. data/lib/purecloud/models/ring.rb +20 -1
  1272. data/lib/purecloud/models/routing_skill.rb +20 -1
  1273. data/lib/purecloud/models/routing_status.rb +20 -1
  1274. data/lib/purecloud/models/rule_set.rb +20 -1
  1275. data/lib/purecloud/models/rule_set_entity_listing.rb +20 -1
  1276. data/lib/purecloud/models/run_now_response.rb +20 -1
  1277. data/lib/purecloud/models/salesforce.rb +20 -1
  1278. data/lib/purecloud/models/schedule.rb +20 -1
  1279. data/lib/purecloud/models/schedule_entity_listing.rb +20 -1
  1280. data/lib/purecloud/models/schedule_group.rb +20 -1
  1281. data/lib/purecloud/models/schedule_group_entity_listing.rb +20 -1
  1282. data/lib/purecloud/models/schema_category.rb +20 -1
  1283. data/lib/purecloud/models/schema_category_entity_listing.rb +20 -1
  1284. data/lib/purecloud/models/schema_reference_entity_listing.rb +20 -1
  1285. data/lib/purecloud/models/script.rb +20 -1
  1286. data/lib/purecloud/models/script_entity_listing.rb +20 -1
  1287. data/lib/purecloud/models/search_aggregation.rb +20 -1
  1288. data/lib/purecloud/models/search_criteria.rb +20 -1
  1289. data/lib/purecloud/models/search_request.rb +20 -1
  1290. data/lib/purecloud/models/security_profile.rb +20 -1
  1291. data/lib/purecloud/models/security_profile_entity_listing.rb +20 -1
  1292. data/lib/purecloud/models/segment.rb +20 -1
  1293. data/lib/purecloud/models/sequence_schedule.rb +21 -2
  1294. data/lib/purecloud/models/server_date.rb +20 -1
  1295. data/lib/purecloud/models/service.rb +20 -1
  1296. data/lib/purecloud/models/service_context.rb +20 -1
  1297. data/lib/purecloud/models/service_entity_listing.rb +20 -1
  1298. data/lib/purecloud/models/service_level.rb +20 -1
  1299. data/lib/purecloud/models/service_type.rb +20 -1
  1300. data/lib/purecloud/models/share.rb +20 -1
  1301. data/lib/purecloud/models/share_entity_listing.rb +20 -1
  1302. data/lib/purecloud/models/shared_entity.rb +20 -1
  1303. data/lib/purecloud/models/shared_response.rb +20 -1
  1304. data/lib/purecloud/models/sheet_schema.rb +20 -1
  1305. data/lib/purecloud/models/sheet_transform.rb +20 -1
  1306. data/lib/purecloud/models/signature_document_info.rb +20 -1
  1307. data/lib/purecloud/models/site.rb +20 -1
  1308. data/lib/purecloud/models/site_entity_listing.rb +20 -1
  1309. data/lib/purecloud/models/skill_entity_listing.rb +20 -1
  1310. data/lib/purecloud/models/skills_to_remove.rb +20 -1
  1311. data/lib/purecloud/models/snapshot.rb +20 -1
  1312. data/lib/purecloud/models/social_account.rb +20 -1
  1313. data/lib/purecloud/models/social_conversation.rb +20 -1
  1314. data/lib/purecloud/models/social_conversation_entity_listing.rb +20 -1
  1315. data/lib/purecloud/models/social_expression.rb +20 -1
  1316. data/lib/purecloud/models/social_media_participant.rb +20 -1
  1317. data/lib/purecloud/models/socialize_entity_filter.rb +20 -1
  1318. data/lib/purecloud/models/socialize_filter_request.rb +20 -1
  1319. data/lib/purecloud/models/sort_by.rb +20 -1
  1320. data/lib/purecloud/models/sort_field.rb +20 -1
  1321. data/lib/purecloud/models/sort_item.rb +20 -1
  1322. data/lib/purecloud/models/spreadsheet_transform.rb +20 -1
  1323. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +20 -1
  1324. data/lib/purecloud/models/station.rb +20 -1
  1325. data/lib/purecloud/models/station_entity_listing.rb +20 -1
  1326. data/lib/purecloud/models/statistical_response.rb +20 -1
  1327. data/lib/purecloud/models/statistical_summary.rb +20 -1
  1328. data/lib/purecloud/models/sub_data_item.rb +20 -1
  1329. data/lib/purecloud/models/subscriber_response.rb +20 -1
  1330. data/lib/purecloud/models/support.rb +20 -1
  1331. data/lib/purecloud/models/system_prompt.rb +20 -1
  1332. data/lib/purecloud/models/system_prompt_asset.rb +20 -1
  1333. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +20 -1
  1334. data/lib/purecloud/models/system_prompt_entity_listing.rb +20 -1
  1335. data/lib/purecloud/models/table_transform.rb +20 -1
  1336. data/lib/purecloud/models/tag_model.rb +20 -1
  1337. data/lib/purecloud/models/tag_query_request.rb +20 -1
  1338. data/lib/purecloud/models/tag_value.rb +20 -1
  1339. data/lib/purecloud/models/tag_value_entity_listing.rb +20 -1
  1340. data/lib/purecloud/models/template_entity_listing.rb +20 -1
  1341. data/lib/purecloud/models/term_attribute.rb +20 -1
  1342. data/lib/purecloud/models/text_table_transform.rb +20 -1
  1343. data/lib/purecloud/models/text_table_transform_entity_listing.rb +20 -1
  1344. data/lib/purecloud/models/third_party_account.rb +20 -1
  1345. data/lib/purecloud/models/third_party_subscription.rb +20 -1
  1346. data/lib/purecloud/models/ticker.rb +20 -1
  1347. data/lib/purecloud/models/tier.rb +20 -1
  1348. data/lib/purecloud/models/time_allowed.rb +20 -1
  1349. data/lib/purecloud/models/time_interval.rb +20 -1
  1350. data/lib/purecloud/models/time_slot.rb +20 -1
  1351. data/lib/purecloud/models/time_zone.rb +20 -1
  1352. data/lib/purecloud/models/time_zone_entity_listing.rb +20 -1
  1353. data/lib/purecloud/models/trace.rb +20 -1
  1354. data/lib/purecloud/models/trace_list.rb +20 -1
  1355. data/lib/purecloud/models/transfer_request.rb +20 -1
  1356. data/lib/purecloud/models/transform_endpoint.rb +20 -1
  1357. data/lib/purecloud/models/transform_lens.rb +20 -1
  1358. data/lib/purecloud/models/trunk_base.rb +21 -2
  1359. data/lib/purecloud/models/trunk_base_assignment.rb +20 -1
  1360. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +20 -1
  1361. data/lib/purecloud/models/twitter_expression.rb +20 -1
  1362. data/lib/purecloud/models/twitter_expression_buffer.rb +20 -1
  1363. data/lib/purecloud/models/unpivot_columns.rb +20 -1
  1364. data/lib/purecloud/models/unread_metric.rb +20 -1
  1365. data/lib/purecloud/models/unread_status.rb +20 -1
  1366. data/lib/purecloud/models/upload_progress.rb +20 -1
  1367. data/lib/purecloud/models/uri_reference.rb +20 -1
  1368. data/lib/purecloud/models/url_response.rb +20 -1
  1369. data/lib/purecloud/models/user.rb +20 -1
  1370. data/lib/purecloud/models/user_action_category.rb +20 -1
  1371. data/lib/purecloud/models/user_action_category_entity_listing.rb +20 -1
  1372. data/lib/purecloud/models/user_action_metadata.rb +20 -1
  1373. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +20 -1
  1374. data/lib/purecloud/models/user_action_metadata_request.rb +20 -1
  1375. data/lib/purecloud/models/user_authorization.rb +20 -1
  1376. data/lib/purecloud/models/user_conversation_summary.rb +20 -1
  1377. data/lib/purecloud/models/user_entity_listing.rb +20 -1
  1378. data/lib/purecloud/models/user_image.rb +20 -1
  1379. data/lib/purecloud/models/user_license_assignment.rb +20 -1
  1380. data/lib/purecloud/models/user_me.rb +21 -2
  1381. data/lib/purecloud/models/user_param.rb +20 -1
  1382. data/lib/purecloud/models/user_presence.rb +20 -1
  1383. data/lib/purecloud/models/user_queue.rb +20 -1
  1384. data/lib/purecloud/models/user_queue_entity_listing.rb +20 -1
  1385. data/lib/purecloud/models/user_recording.rb +20 -1
  1386. data/lib/purecloud/models/user_recording_entity_listing.rb +20 -1
  1387. data/lib/purecloud/models/user_routing_skill.rb +20 -1
  1388. data/lib/purecloud/models/user_skill_entity_listing.rb +20 -1
  1389. data/lib/purecloud/models/user_station.rb +20 -1
  1390. data/lib/purecloud/models/user_stations.rb +20 -1
  1391. data/lib/purecloud/models/users_entity_listing.rb +20 -1
  1392. data/lib/purecloud/models/users_search_response.rb +20 -1
  1393. data/lib/purecloud/models/utilization.rb +20 -1
  1394. data/lib/purecloud/models/validate_address_request.rb +20 -1
  1395. data/lib/purecloud/models/validate_address_response.rb +20 -1
  1396. data/lib/purecloud/models/value.rb +20 -1
  1397. data/lib/purecloud/models/vendor_connection_request.rb +20 -1
  1398. data/lib/purecloud/models/video.rb +20 -1
  1399. data/lib/purecloud/models/video_conversation.rb +20 -1
  1400. data/lib/purecloud/models/video_conversation_entity_listing.rb +20 -1
  1401. data/lib/purecloud/models/video_media_participant.rb +20 -1
  1402. data/lib/purecloud/models/view.rb +20 -1
  1403. data/lib/purecloud/models/voice_rate.rb +20 -1
  1404. data/lib/purecloud/models/voice_rate_extended.rb +20 -1
  1405. data/lib/purecloud/models/voice_rate_international.rb +20 -1
  1406. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +20 -1
  1407. data/lib/purecloud/models/voice_rate_update.rb +20 -1
  1408. data/lib/purecloud/models/voice_rates_csv.rb +20 -1
  1409. data/lib/purecloud/models/voice_xml_operation.rb +20 -1
  1410. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +20 -1
  1411. data/lib/purecloud/models/voicemail_mailbox_info.rb +20 -1
  1412. data/lib/purecloud/models/voicemail_media_info.rb +20 -1
  1413. data/lib/purecloud/models/voicemail_message.rb +20 -1
  1414. data/lib/purecloud/models/voicemail_message_entity_listing.rb +20 -1
  1415. data/lib/purecloud/models/voicemail_organization_policy.rb +20 -1
  1416. data/lib/purecloud/models/voicemail_user_policy.rb +20 -1
  1417. data/lib/purecloud/models/vpn.rb +20 -1
  1418. data/lib/purecloud/models/work_item.rb +20 -1
  1419. data/lib/purecloud/models/work_item_actions.rb +20 -1
  1420. data/lib/purecloud/models/work_item_cache.rb +20 -1
  1421. data/lib/purecloud/models/work_item_command.rb +20 -1
  1422. data/lib/purecloud/models/work_item_command_group.rb +20 -1
  1423. data/lib/purecloud/models/work_item_definition.rb +20 -1
  1424. data/lib/purecloud/models/work_item_details.rb +20 -1
  1425. data/lib/purecloud/models/work_item_search_details.rb +20 -1
  1426. data/lib/purecloud/models/work_item_search_details_search_result.rb +20 -1
  1427. data/lib/purecloud/models/work_item_submit_request.rb +20 -1
  1428. data/lib/purecloud/models/work_item_transfer_request.rb +20 -1
  1429. data/lib/purecloud/models/workspace.rb +20 -1
  1430. data/lib/purecloud/models/workspace_create.rb +20 -1
  1431. data/lib/purecloud/models/workspace_entity_listing.rb +20 -1
  1432. data/lib/purecloud/models/workspace_member.rb +20 -1
  1433. data/lib/purecloud/models/workspace_member_entity_listing.rb +20 -1
  1434. data/lib/purecloud/models/workspace_summary.rb +20 -1
  1435. data/lib/purecloud/models/wrap_up_code_mapping.rb +20 -1
  1436. data/lib/purecloud/models/wrapup.rb +20 -1
  1437. data/lib/purecloud/models/wrapup_code.rb +20 -1
  1438. data/lib/purecloud/models/wrapup_code_entity_listing.rb +20 -1
  1439. data/lib/purecloud/models/xlsx_schema.rb +20 -1
  1440. data/lib/purecloud/version.rb +17 -1
  1441. data/purecloud.gemspec +3 -4
  1442. data/rakefile +13 -23
  1443. data/spec/test.rb +109 -8
  1444. data/swagger_template/README.mustache +72 -0
  1445. data/swagger_template/api_client.mustache +36 -14
  1446. data/swagger_template/api_doc.mustache +80 -0
  1447. data/swagger_template/base_object.mustache +4 -1
  1448. data/swagger_template/gemspec.mustache +3 -4
  1449. data/swagger_template/gitignore.mustache +44 -0
  1450. data/swagger_template/model_doc.mustache +15 -0
  1451. data/version.json +1 -1
  1452. metadata +732 -34
  1453. data/doc/template/default/layout/html/layout.erb +0 -4
  1454. data/doc/template/default/method_details/html/source.erb +0 -0
  1455. data/doc/template/default/module/html/attribute_summary.erb +0 -8
  1456. data/doc/template/default/module/html/box_info.erb +0 -0
  1457. data/doc/template/default/module/html/children.erb +0 -0
  1458. data/lib/purecloud/models/line_properties.rb +0 -136
  1459. data/newVersion.md +0 -1
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: UserRoutingSkill
3
+ ---
4
+ ## PureCloud::UserRoutingSkill
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **proficiency** | **Float** | proficiency of the organization skill. | [optional] |
13
+ | **active** | **BOOLEAN** | Is the user skill active. | [optional] [default to false]|
14
+ | **skill_uri** | **String** | URI to the organization skill used by this user skill. | [optional] |
15
+ | **self_uri** | **String** | The URI for this object | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: UserSkillEntityListing
3
+ ---
4
+ ## PureCloud::UserSkillEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **page_size** | **Integer** | | [optional] |
11
+ | **page_number** | **Integer** | | [optional] |
12
+ | **total** | **Integer** | | [optional] |
13
+ | **entities** | [**Array<UserRoutingSkill>**](UserRoutingSkill.html) | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: UserStation
3
+ ---
4
+ ## PureCloud::UserStation
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | A globally unique identifier for this station | [optional] |
11
+ | **associated_user** | [**User**](User.html) | | [optional] |
12
+ | **associated_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **default_user** | [**User**](User.html) | | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: UserStations
3
+ ---
4
+ ## PureCloud::UserStations
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **associated_station** | [**UserStation**](UserStation.html) | Current associated station for this user. | [optional] |
11
+ | **effective_station** | [**UserStation**](UserStation.html) | The station where the user can be reached based on their default and associated station. | [optional] |
12
+ | **default_station** | [**UserStation**](UserStation.html) | Default station to be used if not associated with a station. | [optional] |
13
+ | **last_associated_station** | [**UserStation**](UserStation.html) | Last associated station for this user. | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,2104 @@
1
+ ---
2
+ title: UsersApi
3
+ ---
4
+
5
+ ## PureCloud::UsersApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | HTTP request | Description
10
+ ------------- | ------------- | -------------
11
+ |[**delete_user_id**](UsersApi.html#delete_user_id) | **DELETE** /api/v2/users/{userId} | Delete user|
12
+ |[**delete_user_id_roles**](UsersApi.html#delete_user_id_roles) | **DELETE** /api/v2/users/{userId}/roles | Removes all the roles from the user.|
13
+ |[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user|
14
+ |[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station|
15
+ |[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station|
16
+ |[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get user.|
17
+ |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search using q64|
18
+ |[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user|
19
+ |[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
20
+ |[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user's Geolocation|
21
+ |[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice|
22
+ |[**get_user_id_presences_source**](UsersApi.html#get_user_id_presences_source) | **GET** /api/v2/users/{userId}/presences/{source} | Get a user's Presence|
23
+ |[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | **GET** /api/v2/users/{userId}/queues | Get queues for user|
24
+ |[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | **GET** /api/v2/users/{userId}/roles | Returns a listing of roles and permissions for a user.|
25
+ |[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user|
26
+ |[**get_user_id_routingstatus**](UsersApi.html#get_user_id_routingstatus) | **GET** /api/v2/users/{userId}/routingstatus | Fetch the routing status of a user|
27
+ |[**get_user_id_station**](UsersApi.html#get_user_id_station) | **GET** /api/v2/users/{userId}/station | Get station information for user|
28
+ |[**get_users**](UsersApi.html#get_users) | **GET** /api/v2/users | Get the list of available users.|
29
+ |[**patch_user_id**](UsersApi.html#patch_user_id) | **PATCH** /api/v2/users/{userId} | Update user|
30
+ |[**patch_user_id_callforwarding**](UsersApi.html#patch_user_id_callforwarding) | **PATCH** /api/v2/users/{userId}/callforwarding | Patch a user's CallForwarding|
31
+ |[**patch_user_id_geolocations_client_id**](UsersApi.html#patch_user_id_geolocations_client_id) | **PATCH** /api/v2/users/{userId}/geolocations/{clientId} | Patch a user's Geolocation|
32
+ |[**patch_user_id_presences_source**](UsersApi.html#patch_user_id_presences_source) | **PATCH** /api/v2/users/{userId}/presences/{source} | Patch a user's Presence|
33
+ |[**patch_user_id_queues**](UsersApi.html#patch_user_id_queues) | **PATCH** /api/v2/users/{userId}/queues | Join or unjoin a set of queues for a user|
34
+ |[**patch_user_id_queues_queue_id**](UsersApi.html#patch_user_id_queues_queue_id) | **PATCH** /api/v2/users/{userId}/queues/{queueId} | Join or unjoin a queue for a user|
35
+ |[**post_search**](UsersApi.html#post_search) | **POST** /api/v2/users/search | Search|
36
+ |[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user|
37
+ |[**post_users**](UsersApi.html#post_users) | **POST** /api/v2/users | Create user|
38
+ |[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates|
39
+ |[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
40
+ |[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | **PUT** /api/v2/users/{userId}/callforwarding | Update a user's CallForwarding|
41
+ |[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | **PUT** /api/v2/users/{userId}/outofoffice | Update an OutOfOffice|
42
+ |[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | **PUT** /api/v2/users/{userId}/roles | Sets the user's roles|
43
+ |[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | **PUT** /api/v2/users/{userId}/routingstatus | Update the routing status of a user|
44
+ |[**put_user_id_station_associatedstation_station_id**](UsersApi.html#put_user_id_station_associatedstation_station_id) | **PUT** /api/v2/users/{userId}/station/associatedstation/{stationId} | Set associated station|
45
+ |[**put_user_id_station_defaultstation_station_id**](UsersApi.html#put_user_id_station_defaultstation_station_id) | **PUT** /api/v2/users/{userId}/station/defaultstation/{stationId} | Set default station|
46
+ {: class="table table-striped"}
47
+
48
+ <a name="delete_user_id"></a>
49
+
50
+ ## -String** delete_user_id(user_id)
51
+
52
+ Delete user
53
+
54
+
55
+
56
+ ### Example
57
+ ~~~ruby
58
+ # load the gem
59
+ require 'purecloud'
60
+ # setup authorization
61
+ @secret = ENV['PURECLOUD_SECRET']
62
+ @id = ENV['PURECLOUD_CLIENT_ID']
63
+ environment = "mypurecloud.com"
64
+
65
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
66
+
67
+ PureCloud.configure do |config|
68
+ config.access_token = @authToken
69
+ end
70
+
71
+ api_instance = PureCloud::UsersApi.new
72
+
73
+ user_id = "user_id_example" # String | User ID
74
+
75
+
76
+ begin
77
+ #Delete user
78
+ result = api_instance.delete_user_id(user_id)
79
+ p result
80
+ rescue PureCloud::ApiError => e
81
+ puts "Exception when calling UsersApi->delete_user_id: #{e}"
82
+ end
83
+ ~~~
84
+
85
+ ### Parameters
86
+
87
+ Name | Type | Description | Notes
88
+ ------------- | ------------- | ------------- | -------------
89
+ **user_id** | **String**| User ID |
90
+ {: class="table table-striped"}
91
+
92
+
93
+ ### Return type
94
+
95
+ **String**
96
+
97
+ ### HTTP request headers
98
+
99
+ - **Content-Type**: application/json
100
+ - **Accept**: application/json
101
+
102
+
103
+
104
+ <a name="delete_user_id_roles"></a>
105
+
106
+ ## - delete_user_id_roles(user_id)
107
+
108
+ Removes all the roles from the user.
109
+
110
+
111
+
112
+ ### Example
113
+ ~~~ruby
114
+ # load the gem
115
+ require 'purecloud'
116
+ # setup authorization
117
+ @secret = ENV['PURECLOUD_SECRET']
118
+ @id = ENV['PURECLOUD_CLIENT_ID']
119
+ environment = "mypurecloud.com"
120
+
121
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
122
+
123
+ PureCloud.configure do |config|
124
+ config.access_token = @authToken
125
+ end
126
+
127
+ api_instance = PureCloud::UsersApi.new
128
+
129
+ user_id = "user_id_example" # String | User ID
130
+
131
+
132
+ begin
133
+ #Removes all the roles from the user.
134
+ api_instance.delete_user_id_roles(user_id)
135
+ rescue PureCloud::ApiError => e
136
+ puts "Exception when calling UsersApi->delete_user_id_roles: #{e}"
137
+ end
138
+ ~~~
139
+
140
+ ### Parameters
141
+
142
+ Name | Type | Description | Notes
143
+ ------------- | ------------- | ------------- | -------------
144
+ **user_id** | **String**| User ID |
145
+ {: class="table table-striped"}
146
+
147
+
148
+ ### Return type
149
+
150
+ nil (empty response body)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: application/json
155
+ - **Accept**: application/json
156
+
157
+
158
+
159
+ <a name="delete_user_id_routingskills_skill_id"></a>
160
+
161
+ ## -String** delete_user_id_routingskills_skill_id(user_id, skill_id)
162
+
163
+ Remove routing skill from user
164
+
165
+
166
+
167
+ ### Example
168
+ ~~~ruby
169
+ # load the gem
170
+ require 'purecloud'
171
+ # setup authorization
172
+ @secret = ENV['PURECLOUD_SECRET']
173
+ @id = ENV['PURECLOUD_CLIENT_ID']
174
+ environment = "mypurecloud.com"
175
+
176
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
177
+
178
+ PureCloud.configure do |config|
179
+ config.access_token = @authToken
180
+ end
181
+
182
+ api_instance = PureCloud::UsersApi.new
183
+
184
+ user_id = "user_id_example" # String | User ID
185
+
186
+ skill_id = "skill_id_example" # String |
187
+
188
+
189
+ begin
190
+ #Remove routing skill from user
191
+ result = api_instance.delete_user_id_routingskills_skill_id(user_id, skill_id)
192
+ p result
193
+ rescue PureCloud::ApiError => e
194
+ puts "Exception when calling UsersApi->delete_user_id_routingskills_skill_id: #{e}"
195
+ end
196
+ ~~~
197
+
198
+ ### Parameters
199
+
200
+ Name | Type | Description | Notes
201
+ ------------- | ------------- | ------------- | -------------
202
+ **user_id** | **String**| User ID |
203
+ **skill_id** | **String**| |
204
+ {: class="table table-striped"}
205
+
206
+
207
+ ### Return type
208
+
209
+ **String**
210
+
211
+ ### HTTP request headers
212
+
213
+ - **Content-Type**: application/json
214
+ - **Accept**: application/json
215
+
216
+
217
+
218
+ <a name="delete_user_id_station_associatedstation"></a>
219
+
220
+ ## - delete_user_id_station_associatedstation(user_id)
221
+
222
+ Clear associated station
223
+
224
+
225
+
226
+ ### Example
227
+ ~~~ruby
228
+ # load the gem
229
+ require 'purecloud'
230
+ # setup authorization
231
+ @secret = ENV['PURECLOUD_SECRET']
232
+ @id = ENV['PURECLOUD_CLIENT_ID']
233
+ environment = "mypurecloud.com"
234
+
235
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
236
+
237
+ PureCloud.configure do |config|
238
+ config.access_token = @authToken
239
+ end
240
+
241
+ api_instance = PureCloud::UsersApi.new
242
+
243
+ user_id = "user_id_example" # String | User ID
244
+
245
+
246
+ begin
247
+ #Clear associated station
248
+ api_instance.delete_user_id_station_associatedstation(user_id)
249
+ rescue PureCloud::ApiError => e
250
+ puts "Exception when calling UsersApi->delete_user_id_station_associatedstation: #{e}"
251
+ end
252
+ ~~~
253
+
254
+ ### Parameters
255
+
256
+ Name | Type | Description | Notes
257
+ ------------- | ------------- | ------------- | -------------
258
+ **user_id** | **String**| User ID |
259
+ {: class="table table-striped"}
260
+
261
+
262
+ ### Return type
263
+
264
+ nil (empty response body)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: application/json
269
+ - **Accept**: application/json
270
+
271
+
272
+
273
+ <a name="delete_user_id_station_defaultstation"></a>
274
+
275
+ ## - delete_user_id_station_defaultstation(user_id)
276
+
277
+ Clear default station
278
+
279
+
280
+
281
+ ### Example
282
+ ~~~ruby
283
+ # load the gem
284
+ require 'purecloud'
285
+ # setup authorization
286
+ @secret = ENV['PURECLOUD_SECRET']
287
+ @id = ENV['PURECLOUD_CLIENT_ID']
288
+ environment = "mypurecloud.com"
289
+
290
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
291
+
292
+ PureCloud.configure do |config|
293
+ config.access_token = @authToken
294
+ end
295
+
296
+ api_instance = PureCloud::UsersApi.new
297
+
298
+ user_id = "user_id_example" # String | User ID
299
+
300
+
301
+ begin
302
+ #Clear default station
303
+ api_instance.delete_user_id_station_defaultstation(user_id)
304
+ rescue PureCloud::ApiError => e
305
+ puts "Exception when calling UsersApi->delete_user_id_station_defaultstation: #{e}"
306
+ end
307
+ ~~~
308
+
309
+ ### Parameters
310
+
311
+ Name | Type | Description | Notes
312
+ ------------- | ------------- | ------------- | -------------
313
+ **user_id** | **String**| User ID |
314
+ {: class="table table-striped"}
315
+
316
+
317
+ ### Return type
318
+
319
+ nil (empty response body)
320
+
321
+ ### HTTP request headers
322
+
323
+ - **Content-Type**: application/json
324
+ - **Accept**: application/json
325
+
326
+
327
+
328
+ <a name="get_me"></a>
329
+
330
+ ## -[**UserMe**](UserMe.html) get_me(opts)
331
+
332
+ Get user.
333
+
334
+
335
+
336
+ ### Example
337
+ ~~~ruby
338
+ # load the gem
339
+ require 'purecloud'
340
+ # setup authorization
341
+ @secret = ENV['PURECLOUD_SECRET']
342
+ @id = ENV['PURECLOUD_CLIENT_ID']
343
+ environment = "mypurecloud.com"
344
+
345
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
346
+
347
+ PureCloud.configure do |config|
348
+ config.access_token = @authToken
349
+ end
350
+
351
+ api_instance = PureCloud::UsersApi.new
352
+
353
+ opts = {
354
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
355
+ }
356
+
357
+ begin
358
+ #Get user.
359
+ result = api_instance.get_me(opts)
360
+ p result
361
+ rescue PureCloud::ApiError => e
362
+ puts "Exception when calling UsersApi->get_me: #{e}"
363
+ end
364
+ ~~~
365
+
366
+ ### Parameters
367
+
368
+ Name | Type | Description | Notes
369
+ ------------- | ------------- | ------------- | -------------
370
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
371
+ {: class="table table-striped"}
372
+
373
+
374
+ ### Return type
375
+
376
+ [**UserMe**](UserMe.html)
377
+
378
+ ### HTTP request headers
379
+
380
+ - **Content-Type**: application/json
381
+ - **Accept**: application/json
382
+
383
+
384
+
385
+ <a name="get_search"></a>
386
+
387
+ ## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search(opts)
388
+
389
+ Search using q64
390
+
391
+
392
+
393
+ ### Example
394
+ ~~~ruby
395
+ # load the gem
396
+ require 'purecloud'
397
+ # setup authorization
398
+ @secret = ENV['PURECLOUD_SECRET']
399
+ @id = ENV['PURECLOUD_CLIENT_ID']
400
+ environment = "mypurecloud.com"
401
+
402
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
403
+
404
+ PureCloud.configure do |config|
405
+ config.access_token = @authToken
406
+ end
407
+
408
+ api_instance = PureCloud::UsersApi.new
409
+
410
+ opts = {
411
+ q64: "q64_example", # String |
412
+ expand: ["expand_example"] # Array<String> |
413
+ }
414
+
415
+ begin
416
+ #Search using q64
417
+ result = api_instance.get_search(opts)
418
+ p result
419
+ rescue PureCloud::ApiError => e
420
+ puts "Exception when calling UsersApi->get_search: #{e}"
421
+ end
422
+ ~~~
423
+
424
+ ### Parameters
425
+
426
+ Name | Type | Description | Notes
427
+ ------------- | ------------- | ------------- | -------------
428
+ **q64** | **String**| | [optional]
429
+ **expand** | [**Array&lt;String&gt;**](String.html)| | [optional]
430
+ {: class="table table-striped"}
431
+
432
+
433
+ ### Return type
434
+
435
+ [**UsersSearchResponse**](UsersSearchResponse.html)
436
+
437
+ ### HTTP request headers
438
+
439
+ - **Content-Type**: application/json
440
+ - **Accept**: application/json
441
+
442
+
443
+
444
+ <a name="get_user_id"></a>
445
+
446
+ ## -[**User**](User.html) get_user_id(user_id, opts)
447
+
448
+ Get user
449
+
450
+
451
+
452
+ ### Example
453
+ ~~~ruby
454
+ # load the gem
455
+ require 'purecloud'
456
+ # setup authorization
457
+ @secret = ENV['PURECLOUD_SECRET']
458
+ @id = ENV['PURECLOUD_CLIENT_ID']
459
+ environment = "mypurecloud.com"
460
+
461
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
462
+
463
+ PureCloud.configure do |config|
464
+ config.access_token = @authToken
465
+ end
466
+
467
+ api_instance = PureCloud::UsersApi.new
468
+
469
+ user_id = "user_id_example" # String | User ID
470
+
471
+ opts = {
472
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
473
+ }
474
+
475
+ begin
476
+ #Get user
477
+ result = api_instance.get_user_id(user_id, opts)
478
+ p result
479
+ rescue PureCloud::ApiError => e
480
+ puts "Exception when calling UsersApi->get_user_id: #{e}"
481
+ end
482
+ ~~~
483
+
484
+ ### Parameters
485
+
486
+ Name | Type | Description | Notes
487
+ ------------- | ------------- | ------------- | -------------
488
+ **user_id** | **String**| User ID |
489
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
490
+ {: class="table table-striped"}
491
+
492
+
493
+ ### Return type
494
+
495
+ [**User**](User.html)
496
+
497
+ ### HTTP request headers
498
+
499
+ - **Content-Type**: application/json
500
+ - **Accept**: application/json
501
+
502
+
503
+
504
+ <a name="get_user_id_callforwarding"></a>
505
+
506
+ ## -[**CallForwarding**](CallForwarding.html) get_user_id_callforwarding(user_id)
507
+
508
+ Get a user's CallForwarding
509
+
510
+
511
+
512
+ ### Example
513
+ ~~~ruby
514
+ # load the gem
515
+ require 'purecloud'
516
+ # setup authorization
517
+ @secret = ENV['PURECLOUD_SECRET']
518
+ @id = ENV['PURECLOUD_CLIENT_ID']
519
+ environment = "mypurecloud.com"
520
+
521
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
522
+
523
+ PureCloud.configure do |config|
524
+ config.access_token = @authToken
525
+ end
526
+
527
+ api_instance = PureCloud::UsersApi.new
528
+
529
+ user_id = "user_id_example" # String | User ID
530
+
531
+
532
+ begin
533
+ #Get a user's CallForwarding
534
+ result = api_instance.get_user_id_callforwarding(user_id)
535
+ p result
536
+ rescue PureCloud::ApiError => e
537
+ puts "Exception when calling UsersApi->get_user_id_callforwarding: #{e}"
538
+ end
539
+ ~~~
540
+
541
+ ### Parameters
542
+
543
+ Name | Type | Description | Notes
544
+ ------------- | ------------- | ------------- | -------------
545
+ **user_id** | **String**| User ID |
546
+ {: class="table table-striped"}
547
+
548
+
549
+ ### Return type
550
+
551
+ [**CallForwarding**](CallForwarding.html)
552
+
553
+ ### HTTP request headers
554
+
555
+ - **Content-Type**: application/json
556
+ - **Accept**: application/json
557
+
558
+
559
+
560
+ <a name="get_user_id_geolocations_client_id"></a>
561
+
562
+ ## -[**Geolocation**](Geolocation.html) get_user_id_geolocations_client_id(user_id, client_id)
563
+
564
+ Get a user's Geolocation
565
+
566
+
567
+
568
+ ### Example
569
+ ~~~ruby
570
+ # load the gem
571
+ require 'purecloud'
572
+ # setup authorization
573
+ @secret = ENV['PURECLOUD_SECRET']
574
+ @id = ENV['PURECLOUD_CLIENT_ID']
575
+ environment = "mypurecloud.com"
576
+
577
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
578
+
579
+ PureCloud.configure do |config|
580
+ config.access_token = @authToken
581
+ end
582
+
583
+ api_instance = PureCloud::UsersApi.new
584
+
585
+ user_id = "user_id_example" # String | user Id
586
+
587
+ client_id = "client_id_example" # String | client Id
588
+
589
+
590
+ begin
591
+ #Get a user's Geolocation
592
+ result = api_instance.get_user_id_geolocations_client_id(user_id, client_id)
593
+ p result
594
+ rescue PureCloud::ApiError => e
595
+ puts "Exception when calling UsersApi->get_user_id_geolocations_client_id: #{e}"
596
+ end
597
+ ~~~
598
+
599
+ ### Parameters
600
+
601
+ Name | Type | Description | Notes
602
+ ------------- | ------------- | ------------- | -------------
603
+ **user_id** | **String**| user Id |
604
+ **client_id** | **String**| client Id |
605
+ {: class="table table-striped"}
606
+
607
+
608
+ ### Return type
609
+
610
+ [**Geolocation**](Geolocation.html)
611
+
612
+ ### HTTP request headers
613
+
614
+ - **Content-Type**: application/json
615
+ - **Accept**: application/json
616
+
617
+
618
+
619
+ <a name="get_user_id_outofoffice"></a>
620
+
621
+ ## -[**OutOfOffice**](OutOfOffice.html) get_user_id_outofoffice(user_id)
622
+
623
+ Get a OutOfOffice
624
+
625
+
626
+
627
+ ### Example
628
+ ~~~ruby
629
+ # load the gem
630
+ require 'purecloud'
631
+ # setup authorization
632
+ @secret = ENV['PURECLOUD_SECRET']
633
+ @id = ENV['PURECLOUD_CLIENT_ID']
634
+ environment = "mypurecloud.com"
635
+
636
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
637
+
638
+ PureCloud.configure do |config|
639
+ config.access_token = @authToken
640
+ end
641
+
642
+ api_instance = PureCloud::UsersApi.new
643
+
644
+ user_id = "user_id_example" # String | User ID
645
+
646
+
647
+ begin
648
+ #Get a OutOfOffice
649
+ result = api_instance.get_user_id_outofoffice(user_id)
650
+ p result
651
+ rescue PureCloud::ApiError => e
652
+ puts "Exception when calling UsersApi->get_user_id_outofoffice: #{e}"
653
+ end
654
+ ~~~
655
+
656
+ ### Parameters
657
+
658
+ Name | Type | Description | Notes
659
+ ------------- | ------------- | ------------- | -------------
660
+ **user_id** | **String**| User ID |
661
+ {: class="table table-striped"}
662
+
663
+
664
+ ### Return type
665
+
666
+ [**OutOfOffice**](OutOfOffice.html)
667
+
668
+ ### HTTP request headers
669
+
670
+ - **Content-Type**: application/json
671
+ - **Accept**: application/json
672
+
673
+
674
+
675
+ <a name="get_user_id_presences_source"></a>
676
+
677
+ ## -[**UserPresence**](UserPresence.html) get_user_id_presences_source(user_id, source)
678
+
679
+ Get a user's Presence
680
+
681
+
682
+
683
+ ### Example
684
+ ~~~ruby
685
+ # load the gem
686
+ require 'purecloud'
687
+ # setup authorization
688
+ @secret = ENV['PURECLOUD_SECRET']
689
+ @id = ENV['PURECLOUD_CLIENT_ID']
690
+ environment = "mypurecloud.com"
691
+
692
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
693
+
694
+ PureCloud.configure do |config|
695
+ config.access_token = @authToken
696
+ end
697
+
698
+ api_instance = PureCloud::UsersApi.new
699
+
700
+ user_id = "user_id_example" # String | user Id
701
+
702
+ source = "source_example" # String | source
703
+
704
+
705
+ begin
706
+ #Get a user's Presence
707
+ result = api_instance.get_user_id_presences_source(user_id, source)
708
+ p result
709
+ rescue PureCloud::ApiError => e
710
+ puts "Exception when calling UsersApi->get_user_id_presences_source: #{e}"
711
+ end
712
+ ~~~
713
+
714
+ ### Parameters
715
+
716
+ Name | Type | Description | Notes
717
+ ------------- | ------------- | ------------- | -------------
718
+ **user_id** | **String**| user Id |
719
+ **source** | **String**| source |
720
+ {: class="table table-striped"}
721
+
722
+
723
+ ### Return type
724
+
725
+ [**UserPresence**](UserPresence.html)
726
+
727
+ ### HTTP request headers
728
+
729
+ - **Content-Type**: application/json
730
+ - **Accept**: application/json
731
+
732
+
733
+
734
+ <a name="get_user_id_queues"></a>
735
+
736
+ ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_id_queues(user_id, opts)
737
+
738
+ Get queues for user
739
+
740
+
741
+
742
+ ### Example
743
+ ~~~ruby
744
+ # load the gem
745
+ require 'purecloud'
746
+ # setup authorization
747
+ @secret = ENV['PURECLOUD_SECRET']
748
+ @id = ENV['PURECLOUD_CLIENT_ID']
749
+ environment = "mypurecloud.com"
750
+
751
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
752
+
753
+ PureCloud.configure do |config|
754
+ config.access_token = @authToken
755
+ end
756
+
757
+ api_instance = PureCloud::UsersApi.new
758
+
759
+ user_id = "user_id_example" # String | User ID
760
+
761
+ opts = {
762
+ page_size: 25, # Integer | Page size
763
+ page_number: 1 # Integer | Page number
764
+ }
765
+
766
+ begin
767
+ #Get queues for user
768
+ result = api_instance.get_user_id_queues(user_id, opts)
769
+ p result
770
+ rescue PureCloud::ApiError => e
771
+ puts "Exception when calling UsersApi->get_user_id_queues: #{e}"
772
+ end
773
+ ~~~
774
+
775
+ ### Parameters
776
+
777
+ Name | Type | Description | Notes
778
+ ------------- | ------------- | ------------- | -------------
779
+ **user_id** | **String**| User ID |
780
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
781
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
782
+ {: class="table table-striped"}
783
+
784
+
785
+ ### Return type
786
+
787
+ [**UserQueueEntityListing**](UserQueueEntityListing.html)
788
+
789
+ ### HTTP request headers
790
+
791
+ - **Content-Type**: application/json
792
+ - **Accept**: application/json
793
+
794
+
795
+
796
+ <a name="get_user_id_roles"></a>
797
+
798
+ ## -[**UserAuthorization**](UserAuthorization.html) get_user_id_roles(user_id)
799
+
800
+ Returns a listing of roles and permissions for a user.
801
+
802
+
803
+
804
+ ### Example
805
+ ~~~ruby
806
+ # load the gem
807
+ require 'purecloud'
808
+ # setup authorization
809
+ @secret = ENV['PURECLOUD_SECRET']
810
+ @id = ENV['PURECLOUD_CLIENT_ID']
811
+ environment = "mypurecloud.com"
812
+
813
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
814
+
815
+ PureCloud.configure do |config|
816
+ config.access_token = @authToken
817
+ end
818
+
819
+ api_instance = PureCloud::UsersApi.new
820
+
821
+ user_id = "user_id_example" # String | User ID
822
+
823
+
824
+ begin
825
+ #Returns a listing of roles and permissions for a user.
826
+ result = api_instance.get_user_id_roles(user_id)
827
+ p result
828
+ rescue PureCloud::ApiError => e
829
+ puts "Exception when calling UsersApi->get_user_id_roles: #{e}"
830
+ end
831
+ ~~~
832
+
833
+ ### Parameters
834
+
835
+ Name | Type | Description | Notes
836
+ ------------- | ------------- | ------------- | -------------
837
+ **user_id** | **String**| User ID |
838
+ {: class="table table-striped"}
839
+
840
+
841
+ ### Return type
842
+
843
+ [**UserAuthorization**](UserAuthorization.html)
844
+
845
+ ### HTTP request headers
846
+
847
+ - **Content-Type**: application/json
848
+ - **Accept**: application/json
849
+
850
+
851
+
852
+ <a name="get_user_id_routingskills"></a>
853
+
854
+ ## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_id_routingskills(user_id, opts)
855
+
856
+ List routing skills for user
857
+
858
+
859
+
860
+ ### Example
861
+ ~~~ruby
862
+ # load the gem
863
+ require 'purecloud'
864
+ # setup authorization
865
+ @secret = ENV['PURECLOUD_SECRET']
866
+ @id = ENV['PURECLOUD_CLIENT_ID']
867
+ environment = "mypurecloud.com"
868
+
869
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
870
+
871
+ PureCloud.configure do |config|
872
+ config.access_token = @authToken
873
+ end
874
+
875
+ api_instance = PureCloud::UsersApi.new
876
+
877
+ user_id = "user_id_example" # String | User ID
878
+
879
+ opts = {
880
+ page_size: 25, # Integer | Page size
881
+ page_number: 1, # Integer | Page number
882
+ sort_order: "ASC" # String | Ascending or descending sort order
883
+ }
884
+
885
+ begin
886
+ #List routing skills for user
887
+ result = api_instance.get_user_id_routingskills(user_id, opts)
888
+ p result
889
+ rescue PureCloud::ApiError => e
890
+ puts "Exception when calling UsersApi->get_user_id_routingskills: #{e}"
891
+ end
892
+ ~~~
893
+
894
+ ### Parameters
895
+
896
+ Name | Type | Description | Notes
897
+ ------------- | ------------- | ------------- | -------------
898
+ **user_id** | **String**| User ID |
899
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
900
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
901
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
902
+ {: class="table table-striped"}
903
+
904
+
905
+ ### Return type
906
+
907
+ [**UserSkillEntityListing**](UserSkillEntityListing.html)
908
+
909
+ ### HTTP request headers
910
+
911
+ - **Content-Type**: application/json
912
+ - **Accept**: application/json
913
+
914
+
915
+
916
+ <a name="get_user_id_routingstatus"></a>
917
+
918
+ ## -[**RoutingStatus**](RoutingStatus.html) get_user_id_routingstatus(user_id)
919
+
920
+ Fetch the routing status of a user
921
+
922
+
923
+
924
+ ### Example
925
+ ~~~ruby
926
+ # load the gem
927
+ require 'purecloud'
928
+ # setup authorization
929
+ @secret = ENV['PURECLOUD_SECRET']
930
+ @id = ENV['PURECLOUD_CLIENT_ID']
931
+ environment = "mypurecloud.com"
932
+
933
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
934
+
935
+ PureCloud.configure do |config|
936
+ config.access_token = @authToken
937
+ end
938
+
939
+ api_instance = PureCloud::UsersApi.new
940
+
941
+ user_id = "user_id_example" # String | User ID
942
+
943
+
944
+ begin
945
+ #Fetch the routing status of a user
946
+ result = api_instance.get_user_id_routingstatus(user_id)
947
+ p result
948
+ rescue PureCloud::ApiError => e
949
+ puts "Exception when calling UsersApi->get_user_id_routingstatus: #{e}"
950
+ end
951
+ ~~~
952
+
953
+ ### Parameters
954
+
955
+ Name | Type | Description | Notes
956
+ ------------- | ------------- | ------------- | -------------
957
+ **user_id** | **String**| User ID |
958
+ {: class="table table-striped"}
959
+
960
+
961
+ ### Return type
962
+
963
+ [**RoutingStatus**](RoutingStatus.html)
964
+
965
+ ### HTTP request headers
966
+
967
+ - **Content-Type**: application/json
968
+ - **Accept**: application/json
969
+
970
+
971
+
972
+ <a name="get_user_id_station"></a>
973
+
974
+ ## -[**UserStations**](UserStations.html) get_user_id_station(user_id)
975
+
976
+ Get station information for user
977
+
978
+
979
+
980
+ ### Example
981
+ ~~~ruby
982
+ # load the gem
983
+ require 'purecloud'
984
+ # setup authorization
985
+ @secret = ENV['PURECLOUD_SECRET']
986
+ @id = ENV['PURECLOUD_CLIENT_ID']
987
+ environment = "mypurecloud.com"
988
+
989
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
990
+
991
+ PureCloud.configure do |config|
992
+ config.access_token = @authToken
993
+ end
994
+
995
+ api_instance = PureCloud::UsersApi.new
996
+
997
+ user_id = "user_id_example" # String | User ID
998
+
999
+
1000
+ begin
1001
+ #Get station information for user
1002
+ result = api_instance.get_user_id_station(user_id)
1003
+ p result
1004
+ rescue PureCloud::ApiError => e
1005
+ puts "Exception when calling UsersApi->get_user_id_station: #{e}"
1006
+ end
1007
+ ~~~
1008
+
1009
+ ### Parameters
1010
+
1011
+ Name | Type | Description | Notes
1012
+ ------------- | ------------- | ------------- | -------------
1013
+ **user_id** | **String**| User ID |
1014
+ {: class="table table-striped"}
1015
+
1016
+
1017
+ ### Return type
1018
+
1019
+ [**UserStations**](UserStations.html)
1020
+
1021
+ ### HTTP request headers
1022
+
1023
+ - **Content-Type**: application/json
1024
+ - **Accept**: application/json
1025
+
1026
+
1027
+
1028
+ <a name="get_users"></a>
1029
+
1030
+ ## -[**UsersEntityListing**](UsersEntityListing.html) get_users(opts)
1031
+
1032
+ Get the list of available users.
1033
+
1034
+
1035
+
1036
+ ### Example
1037
+ ~~~ruby
1038
+ # load the gem
1039
+ require 'purecloud'
1040
+ # setup authorization
1041
+ @secret = ENV['PURECLOUD_SECRET']
1042
+ @id = ENV['PURECLOUD_CLIENT_ID']
1043
+ environment = "mypurecloud.com"
1044
+
1045
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1046
+
1047
+ PureCloud.configure do |config|
1048
+ config.access_token = @authToken
1049
+ end
1050
+
1051
+ api_instance = PureCloud::UsersApi.new
1052
+
1053
+ opts = {
1054
+ page_size: 25, # Integer | Page size
1055
+ page_number: 1, # Integer | Page number
1056
+ id: ["id_example"], # Array<String> | The list of user ids to get. Paging is ignored if ids are specified
1057
+ sort_order: "ASC", # String | Ascending or descending sort order
1058
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
1059
+ }
1060
+
1061
+ begin
1062
+ #Get the list of available users.
1063
+ result = api_instance.get_users(opts)
1064
+ p result
1065
+ rescue PureCloud::ApiError => e
1066
+ puts "Exception when calling UsersApi->get_users: #{e}"
1067
+ end
1068
+ ~~~
1069
+
1070
+ ### Parameters
1071
+
1072
+ Name | Type | Description | Notes
1073
+ ------------- | ------------- | ------------- | -------------
1074
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1075
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1076
+ **id** | [**Array&lt;String&gt;**](String.html)| The list of user ids to get. Paging is ignored if ids are specified | [optional]
1077
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
1078
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
1079
+ {: class="table table-striped"}
1080
+
1081
+
1082
+ ### Return type
1083
+
1084
+ [**UsersEntityListing**](UsersEntityListing.html)
1085
+
1086
+ ### HTTP request headers
1087
+
1088
+ - **Content-Type**: application/json
1089
+ - **Accept**: application/json
1090
+
1091
+
1092
+
1093
+ <a name="patch_user_id"></a>
1094
+
1095
+ ## -[**User**](User.html) patch_user_id(user_id, opts)
1096
+
1097
+ Update user
1098
+
1099
+
1100
+
1101
+ ### Example
1102
+ ~~~ruby
1103
+ # load the gem
1104
+ require 'purecloud'
1105
+ # setup authorization
1106
+ @secret = ENV['PURECLOUD_SECRET']
1107
+ @id = ENV['PURECLOUD_CLIENT_ID']
1108
+ environment = "mypurecloud.com"
1109
+
1110
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1111
+
1112
+ PureCloud.configure do |config|
1113
+ config.access_token = @authToken
1114
+ end
1115
+
1116
+ api_instance = PureCloud::UsersApi.new
1117
+
1118
+ user_id = "user_id_example" # String | User ID
1119
+
1120
+ opts = {
1121
+ body: PureCloud::User.new # User |
1122
+ }
1123
+
1124
+ begin
1125
+ #Update user
1126
+ result = api_instance.patch_user_id(user_id, opts)
1127
+ p result
1128
+ rescue PureCloud::ApiError => e
1129
+ puts "Exception when calling UsersApi->patch_user_id: #{e}"
1130
+ end
1131
+ ~~~
1132
+
1133
+ ### Parameters
1134
+
1135
+ Name | Type | Description | Notes
1136
+ ------------- | ------------- | ------------- | -------------
1137
+ **user_id** | **String**| User ID |
1138
+ **body** | [**User**](User.html)| | [optional]
1139
+ {: class="table table-striped"}
1140
+
1141
+
1142
+ ### Return type
1143
+
1144
+ [**User**](User.html)
1145
+
1146
+ ### HTTP request headers
1147
+
1148
+ - **Content-Type**: application/json
1149
+ - **Accept**: application/json
1150
+
1151
+
1152
+
1153
+ <a name="patch_user_id_callforwarding"></a>
1154
+
1155
+ ## -[**CallForwarding**](CallForwarding.html) patch_user_id_callforwarding(user_id, opts)
1156
+
1157
+ Patch a user's CallForwarding
1158
+
1159
+
1160
+
1161
+ ### Example
1162
+ ~~~ruby
1163
+ # load the gem
1164
+ require 'purecloud'
1165
+ # setup authorization
1166
+ @secret = ENV['PURECLOUD_SECRET']
1167
+ @id = ENV['PURECLOUD_CLIENT_ID']
1168
+ environment = "mypurecloud.com"
1169
+
1170
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1171
+
1172
+ PureCloud.configure do |config|
1173
+ config.access_token = @authToken
1174
+ end
1175
+
1176
+ api_instance = PureCloud::UsersApi.new
1177
+
1178
+ user_id = "user_id_example" # String | User ID
1179
+
1180
+ opts = {
1181
+ body: PureCloud::CallForwarding.new # CallForwarding |
1182
+ }
1183
+
1184
+ begin
1185
+ #Patch a user's CallForwarding
1186
+ result = api_instance.patch_user_id_callforwarding(user_id, opts)
1187
+ p result
1188
+ rescue PureCloud::ApiError => e
1189
+ puts "Exception when calling UsersApi->patch_user_id_callforwarding: #{e}"
1190
+ end
1191
+ ~~~
1192
+
1193
+ ### Parameters
1194
+
1195
+ Name | Type | Description | Notes
1196
+ ------------- | ------------- | ------------- | -------------
1197
+ **user_id** | **String**| User ID |
1198
+ **body** | [**CallForwarding**](CallForwarding.html)| | [optional]
1199
+ {: class="table table-striped"}
1200
+
1201
+
1202
+ ### Return type
1203
+
1204
+ [**CallForwarding**](CallForwarding.html)
1205
+
1206
+ ### HTTP request headers
1207
+
1208
+ - **Content-Type**: application/json
1209
+ - **Accept**: application/json
1210
+
1211
+
1212
+
1213
+ <a name="patch_user_id_geolocations_client_id"></a>
1214
+
1215
+ ## -[**Geolocation**](Geolocation.html) patch_user_id_geolocations_client_id(user_id, client_id, opts)
1216
+
1217
+ Patch a user's Geolocation
1218
+
1219
+ 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.
1220
+
1221
+ ### Example
1222
+ ~~~ruby
1223
+ # load the gem
1224
+ require 'purecloud'
1225
+ # setup authorization
1226
+ @secret = ENV['PURECLOUD_SECRET']
1227
+ @id = ENV['PURECLOUD_CLIENT_ID']
1228
+ environment = "mypurecloud.com"
1229
+
1230
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1231
+
1232
+ PureCloud.configure do |config|
1233
+ config.access_token = @authToken
1234
+ end
1235
+
1236
+ api_instance = PureCloud::UsersApi.new
1237
+
1238
+ user_id = "user_id_example" # String | user Id
1239
+
1240
+ client_id = "client_id_example" # String | client Id
1241
+
1242
+ opts = {
1243
+ body: PureCloud::Geolocation.new # Geolocation |
1244
+ }
1245
+
1246
+ begin
1247
+ #Patch a user's Geolocation
1248
+ result = api_instance.patch_user_id_geolocations_client_id(user_id, client_id, opts)
1249
+ p result
1250
+ rescue PureCloud::ApiError => e
1251
+ puts "Exception when calling UsersApi->patch_user_id_geolocations_client_id: #{e}"
1252
+ end
1253
+ ~~~
1254
+
1255
+ ### Parameters
1256
+
1257
+ Name | Type | Description | Notes
1258
+ ------------- | ------------- | ------------- | -------------
1259
+ **user_id** | **String**| user Id |
1260
+ **client_id** | **String**| client Id |
1261
+ **body** | [**Geolocation**](Geolocation.html)| | [optional]
1262
+ {: class="table table-striped"}
1263
+
1264
+
1265
+ ### Return type
1266
+
1267
+ [**Geolocation**](Geolocation.html)
1268
+
1269
+ ### HTTP request headers
1270
+
1271
+ - **Content-Type**: application/json
1272
+ - **Accept**: application/json
1273
+
1274
+
1275
+
1276
+ <a name="patch_user_id_presences_source"></a>
1277
+
1278
+ ## -[**UserPresence**](UserPresence.html) patch_user_id_presences_source(user_id, source, opts)
1279
+
1280
+ Patch a user's Presence
1281
+
1282
+ The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3.
1283
+
1284
+ ### Example
1285
+ ~~~ruby
1286
+ # load the gem
1287
+ require 'purecloud'
1288
+ # setup authorization
1289
+ @secret = ENV['PURECLOUD_SECRET']
1290
+ @id = ENV['PURECLOUD_CLIENT_ID']
1291
+ environment = "mypurecloud.com"
1292
+
1293
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1294
+
1295
+ PureCloud.configure do |config|
1296
+ config.access_token = @authToken
1297
+ end
1298
+
1299
+ api_instance = PureCloud::UsersApi.new
1300
+
1301
+ user_id = "user_id_example" # String | user Id
1302
+
1303
+ source = "source_example" # String | source
1304
+
1305
+ opts = {
1306
+ body: PureCloud::UserPresence.new # UserPresence |
1307
+ }
1308
+
1309
+ begin
1310
+ #Patch a user's Presence
1311
+ result = api_instance.patch_user_id_presences_source(user_id, source, opts)
1312
+ p result
1313
+ rescue PureCloud::ApiError => e
1314
+ puts "Exception when calling UsersApi->patch_user_id_presences_source: #{e}"
1315
+ end
1316
+ ~~~
1317
+
1318
+ ### Parameters
1319
+
1320
+ Name | Type | Description | Notes
1321
+ ------------- | ------------- | ------------- | -------------
1322
+ **user_id** | **String**| user Id |
1323
+ **source** | **String**| source |
1324
+ **body** | [**UserPresence**](UserPresence.html)| | [optional]
1325
+ {: class="table table-striped"}
1326
+
1327
+
1328
+ ### Return type
1329
+
1330
+ [**UserPresence**](UserPresence.html)
1331
+
1332
+ ### HTTP request headers
1333
+
1334
+ - **Content-Type**: application/json
1335
+ - **Accept**: application/json
1336
+
1337
+
1338
+
1339
+ <a name="patch_user_id_queues"></a>
1340
+
1341
+ ## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id, opts)
1342
+
1343
+ Join or unjoin a set of queues for a user
1344
+
1345
+
1346
+
1347
+ ### Example
1348
+ ~~~ruby
1349
+ # load the gem
1350
+ require 'purecloud'
1351
+ # setup authorization
1352
+ @secret = ENV['PURECLOUD_SECRET']
1353
+ @id = ENV['PURECLOUD_CLIENT_ID']
1354
+ environment = "mypurecloud.com"
1355
+
1356
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1357
+
1358
+ PureCloud.configure do |config|
1359
+ config.access_token = @authToken
1360
+ end
1361
+
1362
+ api_instance = PureCloud::UsersApi.new
1363
+
1364
+ user_id = "user_id_example" # String | User ID
1365
+
1366
+ opts = {
1367
+ body: [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues
1368
+ }
1369
+
1370
+ begin
1371
+ #Join or unjoin a set of queues for a user
1372
+ result = api_instance.patch_user_id_queues(user_id, opts)
1373
+ p result
1374
+ rescue PureCloud::ApiError => e
1375
+ puts "Exception when calling UsersApi->patch_user_id_queues: #{e}"
1376
+ end
1377
+ ~~~
1378
+
1379
+ ### Parameters
1380
+
1381
+ Name | Type | Description | Notes
1382
+ ------------- | ------------- | ------------- | -------------
1383
+ **user_id** | **String**| User ID |
1384
+ **body** | [**Array&lt;UserQueue&gt;**](UserQueue.html)| User Queues | [optional]
1385
+ {: class="table table-striped"}
1386
+
1387
+
1388
+ ### Return type
1389
+
1390
+ [**UserQueue**](UserQueue.html)
1391
+
1392
+ ### HTTP request headers
1393
+
1394
+ - **Content-Type**: application/json
1395
+ - **Accept**: application/json
1396
+
1397
+
1398
+
1399
+ <a name="patch_user_id_queues_queue_id"></a>
1400
+
1401
+ ## -[**UserQueue**](UserQueue.html) patch_user_id_queues_queue_id(queue_id, user_id, opts)
1402
+
1403
+ Join or unjoin a queue for a user
1404
+
1405
+
1406
+
1407
+ ### Example
1408
+ ~~~ruby
1409
+ # load the gem
1410
+ require 'purecloud'
1411
+ # setup authorization
1412
+ @secret = ENV['PURECLOUD_SECRET']
1413
+ @id = ENV['PURECLOUD_CLIENT_ID']
1414
+ environment = "mypurecloud.com"
1415
+
1416
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1417
+
1418
+ PureCloud.configure do |config|
1419
+ config.access_token = @authToken
1420
+ end
1421
+
1422
+ api_instance = PureCloud::UsersApi.new
1423
+
1424
+ queue_id = "queue_id_example" # String | Queue ID
1425
+
1426
+ user_id = "user_id_example" # String | User ID
1427
+
1428
+ opts = {
1429
+ body: PureCloud::UserQueue.new # UserQueue | Queue Member
1430
+ }
1431
+
1432
+ begin
1433
+ #Join or unjoin a queue for a user
1434
+ result = api_instance.patch_user_id_queues_queue_id(queue_id, user_id, opts)
1435
+ p result
1436
+ rescue PureCloud::ApiError => e
1437
+ puts "Exception when calling UsersApi->patch_user_id_queues_queue_id: #{e}"
1438
+ end
1439
+ ~~~
1440
+
1441
+ ### Parameters
1442
+
1443
+ Name | Type | Description | Notes
1444
+ ------------- | ------------- | ------------- | -------------
1445
+ **queue_id** | **String**| Queue ID |
1446
+ **user_id** | **String**| User ID |
1447
+ **body** | [**UserQueue**](UserQueue.html)| Queue Member | [optional]
1448
+ {: class="table table-striped"}
1449
+
1450
+
1451
+ ### Return type
1452
+
1453
+ [**UserQueue**](UserQueue.html)
1454
+
1455
+ ### HTTP request headers
1456
+
1457
+ - **Content-Type**: application/json
1458
+ - **Accept**: application/json
1459
+
1460
+
1461
+
1462
+ <a name="post_search"></a>
1463
+
1464
+ ## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search(opts)
1465
+
1466
+ Search
1467
+
1468
+
1469
+
1470
+ ### Example
1471
+ ~~~ruby
1472
+ # load the gem
1473
+ require 'purecloud'
1474
+ # setup authorization
1475
+ @secret = ENV['PURECLOUD_SECRET']
1476
+ @id = ENV['PURECLOUD_CLIENT_ID']
1477
+ environment = "mypurecloud.com"
1478
+
1479
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1480
+
1481
+ PureCloud.configure do |config|
1482
+ config.access_token = @authToken
1483
+ end
1484
+
1485
+ api_instance = PureCloud::UsersApi.new
1486
+
1487
+ opts = {
1488
+ body: PureCloud::SearchRequest.new # SearchRequest | Search request options
1489
+ }
1490
+
1491
+ begin
1492
+ #Search
1493
+ result = api_instance.post_search(opts)
1494
+ p result
1495
+ rescue PureCloud::ApiError => e
1496
+ puts "Exception when calling UsersApi->post_search: #{e}"
1497
+ end
1498
+ ~~~
1499
+
1500
+ ### Parameters
1501
+
1502
+ Name | Type | Description | Notes
1503
+ ------------- | ------------- | ------------- | -------------
1504
+ **body** | [**SearchRequest**](SearchRequest.html)| Search request options | [optional]
1505
+ {: class="table table-striped"}
1506
+
1507
+
1508
+ ### Return type
1509
+
1510
+ [**UsersSearchResponse**](UsersSearchResponse.html)
1511
+
1512
+ ### HTTP request headers
1513
+
1514
+ - **Content-Type**: application/json
1515
+ - **Accept**: application/json
1516
+
1517
+
1518
+
1519
+ <a name="post_user_id_routingskills"></a>
1520
+
1521
+ ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, opts)
1522
+
1523
+ Add routing skill to user
1524
+
1525
+
1526
+
1527
+ ### Example
1528
+ ~~~ruby
1529
+ # load the gem
1530
+ require 'purecloud'
1531
+ # setup authorization
1532
+ @secret = ENV['PURECLOUD_SECRET']
1533
+ @id = ENV['PURECLOUD_CLIENT_ID']
1534
+ environment = "mypurecloud.com"
1535
+
1536
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1537
+
1538
+ PureCloud.configure do |config|
1539
+ config.access_token = @authToken
1540
+ end
1541
+
1542
+ api_instance = PureCloud::UsersApi.new
1543
+
1544
+ user_id = "user_id_example" # String | User ID
1545
+
1546
+ opts = {
1547
+ body: PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill
1548
+ }
1549
+
1550
+ begin
1551
+ #Add routing skill to user
1552
+ result = api_instance.post_user_id_routingskills(user_id, opts)
1553
+ p result
1554
+ rescue PureCloud::ApiError => e
1555
+ puts "Exception when calling UsersApi->post_user_id_routingskills: #{e}"
1556
+ end
1557
+ ~~~
1558
+
1559
+ ### Parameters
1560
+
1561
+ Name | Type | Description | Notes
1562
+ ------------- | ------------- | ------------- | -------------
1563
+ **user_id** | **String**| User ID |
1564
+ **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | [optional]
1565
+ {: class="table table-striped"}
1566
+
1567
+
1568
+ ### Return type
1569
+
1570
+ [**UserRoutingSkill**](UserRoutingSkill.html)
1571
+
1572
+ ### HTTP request headers
1573
+
1574
+ - **Content-Type**: application/json
1575
+ - **Accept**: application/json
1576
+
1577
+
1578
+
1579
+ <a name="post_users"></a>
1580
+
1581
+ ## -[**User**](User.html) post_users(opts)
1582
+
1583
+ Create user
1584
+
1585
+
1586
+
1587
+ ### Example
1588
+ ~~~ruby
1589
+ # load the gem
1590
+ require 'purecloud'
1591
+ # setup authorization
1592
+ @secret = ENV['PURECLOUD_SECRET']
1593
+ @id = ENV['PURECLOUD_CLIENT_ID']
1594
+ environment = "mypurecloud.com"
1595
+
1596
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1597
+
1598
+ PureCloud.configure do |config|
1599
+ config.access_token = @authToken
1600
+ end
1601
+
1602
+ api_instance = PureCloud::UsersApi.new
1603
+
1604
+ opts = {
1605
+ body: PureCloud::CreateUser.new # CreateUser | User
1606
+ }
1607
+
1608
+ begin
1609
+ #Create user
1610
+ result = api_instance.post_users(opts)
1611
+ p result
1612
+ rescue PureCloud::ApiError => e
1613
+ puts "Exception when calling UsersApi->post_users: #{e}"
1614
+ end
1615
+ ~~~
1616
+
1617
+ ### Parameters
1618
+
1619
+ Name | Type | Description | Notes
1620
+ ------------- | ------------- | ------------- | -------------
1621
+ **body** | [**CreateUser**](CreateUser.html)| User | [optional]
1622
+ {: class="table table-striped"}
1623
+
1624
+
1625
+ ### Return type
1626
+
1627
+ [**User**](User.html)
1628
+
1629
+ ### HTTP request headers
1630
+
1631
+ - **Content-Type**: application/json
1632
+ - **Accept**: application/json
1633
+
1634
+
1635
+
1636
+ <a name="post_users_aggregates_query"></a>
1637
+
1638
+ ## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(opts)
1639
+
1640
+ Query for user aggregates
1641
+
1642
+
1643
+
1644
+ ### Example
1645
+ ~~~ruby
1646
+ # load the gem
1647
+ require 'purecloud'
1648
+ # setup authorization
1649
+ @secret = ENV['PURECLOUD_SECRET']
1650
+ @id = ENV['PURECLOUD_CLIENT_ID']
1651
+ environment = "mypurecloud.com"
1652
+
1653
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1654
+
1655
+ PureCloud.configure do |config|
1656
+ config.access_token = @authToken
1657
+ end
1658
+
1659
+ api_instance = PureCloud::UsersApi.new
1660
+
1661
+ opts = {
1662
+ body: PureCloud::AggregationQuery.new # AggregationQuery | query
1663
+ }
1664
+
1665
+ begin
1666
+ #Query for user aggregates
1667
+ result = api_instance.post_users_aggregates_query(opts)
1668
+ p result
1669
+ rescue PureCloud::ApiError => e
1670
+ puts "Exception when calling UsersApi->post_users_aggregates_query: #{e}"
1671
+ end
1672
+ ~~~
1673
+
1674
+ ### Parameters
1675
+
1676
+ Name | Type | Description | Notes
1677
+ ------------- | ------------- | ------------- | -------------
1678
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional]
1679
+ {: class="table table-striped"}
1680
+
1681
+
1682
+ ### Return type
1683
+
1684
+ [**PresenceQueryResponse**](PresenceQueryResponse.html)
1685
+
1686
+ ### HTTP request headers
1687
+
1688
+ - **Content-Type**: application/json
1689
+ - **Accept**: application/json
1690
+
1691
+
1692
+
1693
+ <a name="post_users_observations_query"></a>
1694
+
1695
+ ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(opts)
1696
+
1697
+ Query for user observations
1698
+
1699
+
1700
+
1701
+ ### Example
1702
+ ~~~ruby
1703
+ # load the gem
1704
+ require 'purecloud'
1705
+ # setup authorization
1706
+ @secret = ENV['PURECLOUD_SECRET']
1707
+ @id = ENV['PURECLOUD_CLIENT_ID']
1708
+ environment = "mypurecloud.com"
1709
+
1710
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1711
+
1712
+ PureCloud.configure do |config|
1713
+ config.access_token = @authToken
1714
+ end
1715
+
1716
+ api_instance = PureCloud::UsersApi.new
1717
+
1718
+ opts = {
1719
+ body: PureCloud::ObservationQuery.new # ObservationQuery | query
1720
+ }
1721
+
1722
+ begin
1723
+ #Query for user observations
1724
+ result = api_instance.post_users_observations_query(opts)
1725
+ p result
1726
+ rescue PureCloud::ApiError => e
1727
+ puts "Exception when calling UsersApi->post_users_observations_query: #{e}"
1728
+ end
1729
+ ~~~
1730
+
1731
+ ### Parameters
1732
+
1733
+ Name | Type | Description | Notes
1734
+ ------------- | ------------- | ------------- | -------------
1735
+ **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional]
1736
+ {: class="table table-striped"}
1737
+
1738
+
1739
+ ### Return type
1740
+
1741
+ [**ObservationQueryResponse**](ObservationQueryResponse.html)
1742
+
1743
+ ### HTTP request headers
1744
+
1745
+ - **Content-Type**: application/json
1746
+ - **Accept**: application/json
1747
+
1748
+
1749
+
1750
+ <a name="put_user_id_callforwarding"></a>
1751
+
1752
+ ## -[**CallForwarding**](CallForwarding.html) put_user_id_callforwarding(user_id, opts)
1753
+
1754
+ Update a user's CallForwarding
1755
+
1756
+
1757
+
1758
+ ### Example
1759
+ ~~~ruby
1760
+ # load the gem
1761
+ require 'purecloud'
1762
+ # setup authorization
1763
+ @secret = ENV['PURECLOUD_SECRET']
1764
+ @id = ENV['PURECLOUD_CLIENT_ID']
1765
+ environment = "mypurecloud.com"
1766
+
1767
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1768
+
1769
+ PureCloud.configure do |config|
1770
+ config.access_token = @authToken
1771
+ end
1772
+
1773
+ api_instance = PureCloud::UsersApi.new
1774
+
1775
+ user_id = "user_id_example" # String | User ID
1776
+
1777
+ opts = {
1778
+ body: PureCloud::CallForwarding.new # CallForwarding |
1779
+ }
1780
+
1781
+ begin
1782
+ #Update a user's CallForwarding
1783
+ result = api_instance.put_user_id_callforwarding(user_id, opts)
1784
+ p result
1785
+ rescue PureCloud::ApiError => e
1786
+ puts "Exception when calling UsersApi->put_user_id_callforwarding: #{e}"
1787
+ end
1788
+ ~~~
1789
+
1790
+ ### Parameters
1791
+
1792
+ Name | Type | Description | Notes
1793
+ ------------- | ------------- | ------------- | -------------
1794
+ **user_id** | **String**| User ID |
1795
+ **body** | [**CallForwarding**](CallForwarding.html)| | [optional]
1796
+ {: class="table table-striped"}
1797
+
1798
+
1799
+ ### Return type
1800
+
1801
+ [**CallForwarding**](CallForwarding.html)
1802
+
1803
+ ### HTTP request headers
1804
+
1805
+ - **Content-Type**: application/json
1806
+ - **Accept**: application/json
1807
+
1808
+
1809
+
1810
+ <a name="put_user_id_outofoffice"></a>
1811
+
1812
+ ## -[**OutOfOffice**](OutOfOffice.html) put_user_id_outofoffice(user_id, body)
1813
+
1814
+ Update an OutOfOffice
1815
+
1816
+
1817
+
1818
+ ### Example
1819
+ ~~~ruby
1820
+ # load the gem
1821
+ require 'purecloud'
1822
+ # setup authorization
1823
+ @secret = ENV['PURECLOUD_SECRET']
1824
+ @id = ENV['PURECLOUD_CLIENT_ID']
1825
+ environment = "mypurecloud.com"
1826
+
1827
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1828
+
1829
+ PureCloud.configure do |config|
1830
+ config.access_token = @authToken
1831
+ end
1832
+
1833
+ api_instance = PureCloud::UsersApi.new
1834
+
1835
+ user_id = "user_id_example" # String | User ID
1836
+
1837
+ body = PureCloud::OutOfOffice.new # OutOfOffice | The updated UserPresence
1838
+
1839
+
1840
+ begin
1841
+ #Update an OutOfOffice
1842
+ result = api_instance.put_user_id_outofoffice(user_id, body)
1843
+ p result
1844
+ rescue PureCloud::ApiError => e
1845
+ puts "Exception when calling UsersApi->put_user_id_outofoffice: #{e}"
1846
+ end
1847
+ ~~~
1848
+
1849
+ ### Parameters
1850
+
1851
+ Name | Type | Description | Notes
1852
+ ------------- | ------------- | ------------- | -------------
1853
+ **user_id** | **String**| User ID |
1854
+ **body** | [**OutOfOffice**](OutOfOffice.html)| The updated UserPresence |
1855
+ {: class="table table-striped"}
1856
+
1857
+
1858
+ ### Return type
1859
+
1860
+ [**OutOfOffice**](OutOfOffice.html)
1861
+
1862
+ ### HTTP request headers
1863
+
1864
+ - **Content-Type**: application/json
1865
+ - **Accept**: application/json
1866
+
1867
+
1868
+
1869
+ <a name="put_user_id_roles"></a>
1870
+
1871
+ ## -[**UserAuthorization**](UserAuthorization.html) put_user_id_roles(user_id, opts)
1872
+
1873
+ Sets the user's roles
1874
+
1875
+
1876
+
1877
+ ### Example
1878
+ ~~~ruby
1879
+ # load the gem
1880
+ require 'purecloud'
1881
+ # setup authorization
1882
+ @secret = ENV['PURECLOUD_SECRET']
1883
+ @id = ENV['PURECLOUD_CLIENT_ID']
1884
+ environment = "mypurecloud.com"
1885
+
1886
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1887
+
1888
+ PureCloud.configure do |config|
1889
+ config.access_token = @authToken
1890
+ end
1891
+
1892
+ api_instance = PureCloud::UsersApi.new
1893
+
1894
+ user_id = "user_id_example" # String | User ID
1895
+
1896
+ opts = {
1897
+ body: [PureCloud::Array<String>.new] # Array<String> |
1898
+ }
1899
+
1900
+ begin
1901
+ #Sets the user's roles
1902
+ result = api_instance.put_user_id_roles(user_id, opts)
1903
+ p result
1904
+ rescue PureCloud::ApiError => e
1905
+ puts "Exception when calling UsersApi->put_user_id_roles: #{e}"
1906
+ end
1907
+ ~~~
1908
+
1909
+ ### Parameters
1910
+
1911
+ Name | Type | Description | Notes
1912
+ ------------- | ------------- | ------------- | -------------
1913
+ **user_id** | **String**| User ID |
1914
+ **body** | **Array&lt;String&gt;**| | [optional]
1915
+ {: class="table table-striped"}
1916
+
1917
+
1918
+ ### Return type
1919
+
1920
+ [**UserAuthorization**](UserAuthorization.html)
1921
+
1922
+ ### HTTP request headers
1923
+
1924
+ - **Content-Type**: application/json
1925
+ - **Accept**: application/json
1926
+
1927
+
1928
+
1929
+ <a name="put_user_id_routingstatus"></a>
1930
+
1931
+ ## -[**RoutingStatus**](RoutingStatus.html) put_user_id_routingstatus(user_id, opts)
1932
+
1933
+ Update the routing status of a user
1934
+
1935
+
1936
+
1937
+ ### Example
1938
+ ~~~ruby
1939
+ # load the gem
1940
+ require 'purecloud'
1941
+ # setup authorization
1942
+ @secret = ENV['PURECLOUD_SECRET']
1943
+ @id = ENV['PURECLOUD_CLIENT_ID']
1944
+ environment = "mypurecloud.com"
1945
+
1946
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1947
+
1948
+ PureCloud.configure do |config|
1949
+ config.access_token = @authToken
1950
+ end
1951
+
1952
+ api_instance = PureCloud::UsersApi.new
1953
+
1954
+ user_id = "user_id_example" # String | User ID
1955
+
1956
+ opts = {
1957
+ body: PureCloud::RoutingStatus.new # RoutingStatus | Routing Status
1958
+ }
1959
+
1960
+ begin
1961
+ #Update the routing status of a user
1962
+ result = api_instance.put_user_id_routingstatus(user_id, opts)
1963
+ p result
1964
+ rescue PureCloud::ApiError => e
1965
+ puts "Exception when calling UsersApi->put_user_id_routingstatus: #{e}"
1966
+ end
1967
+ ~~~
1968
+
1969
+ ### Parameters
1970
+
1971
+ Name | Type | Description | Notes
1972
+ ------------- | ------------- | ------------- | -------------
1973
+ **user_id** | **String**| User ID |
1974
+ **body** | [**RoutingStatus**](RoutingStatus.html)| Routing Status | [optional]
1975
+ {: class="table table-striped"}
1976
+
1977
+
1978
+ ### Return type
1979
+
1980
+ [**RoutingStatus**](RoutingStatus.html)
1981
+
1982
+ ### HTTP request headers
1983
+
1984
+ - **Content-Type**: application/json
1985
+ - **Accept**: application/json
1986
+
1987
+
1988
+
1989
+ <a name="put_user_id_station_associatedstation_station_id"></a>
1990
+
1991
+ ## - put_user_id_station_associatedstation_station_id(user_id, station_id)
1992
+
1993
+ Set associated station
1994
+
1995
+
1996
+
1997
+ ### Example
1998
+ ~~~ruby
1999
+ # load the gem
2000
+ require 'purecloud'
2001
+ # setup authorization
2002
+ @secret = ENV['PURECLOUD_SECRET']
2003
+ @id = ENV['PURECLOUD_CLIENT_ID']
2004
+ environment = "mypurecloud.com"
2005
+
2006
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2007
+
2008
+ PureCloud.configure do |config|
2009
+ config.access_token = @authToken
2010
+ end
2011
+
2012
+ api_instance = PureCloud::UsersApi.new
2013
+
2014
+ user_id = "user_id_example" # String | User ID
2015
+
2016
+ station_id = "station_id_example" # String |
2017
+
2018
+
2019
+ begin
2020
+ #Set associated station
2021
+ api_instance.put_user_id_station_associatedstation_station_id(user_id, station_id)
2022
+ rescue PureCloud::ApiError => e
2023
+ puts "Exception when calling UsersApi->put_user_id_station_associatedstation_station_id: #{e}"
2024
+ end
2025
+ ~~~
2026
+
2027
+ ### Parameters
2028
+
2029
+ Name | Type | Description | Notes
2030
+ ------------- | ------------- | ------------- | -------------
2031
+ **user_id** | **String**| User ID |
2032
+ **station_id** | **String**| |
2033
+ {: class="table table-striped"}
2034
+
2035
+
2036
+ ### Return type
2037
+
2038
+ nil (empty response body)
2039
+
2040
+ ### HTTP request headers
2041
+
2042
+ - **Content-Type**: application/json
2043
+ - **Accept**: application/json
2044
+
2045
+
2046
+
2047
+ <a name="put_user_id_station_defaultstation_station_id"></a>
2048
+
2049
+ ## - put_user_id_station_defaultstation_station_id(user_id, station_id)
2050
+
2051
+ Set default station
2052
+
2053
+
2054
+
2055
+ ### Example
2056
+ ~~~ruby
2057
+ # load the gem
2058
+ require 'purecloud'
2059
+ # setup authorization
2060
+ @secret = ENV['PURECLOUD_SECRET']
2061
+ @id = ENV['PURECLOUD_CLIENT_ID']
2062
+ environment = "mypurecloud.com"
2063
+
2064
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2065
+
2066
+ PureCloud.configure do |config|
2067
+ config.access_token = @authToken
2068
+ end
2069
+
2070
+ api_instance = PureCloud::UsersApi.new
2071
+
2072
+ user_id = "user_id_example" # String | User ID
2073
+
2074
+ station_id = "station_id_example" # String |
2075
+
2076
+
2077
+ begin
2078
+ #Set default station
2079
+ api_instance.put_user_id_station_defaultstation_station_id(user_id, station_id)
2080
+ rescue PureCloud::ApiError => e
2081
+ puts "Exception when calling UsersApi->put_user_id_station_defaultstation_station_id: #{e}"
2082
+ end
2083
+ ~~~
2084
+
2085
+ ### Parameters
2086
+
2087
+ Name | Type | Description | Notes
2088
+ ------------- | ------------- | ------------- | -------------
2089
+ **user_id** | **String**| User ID |
2090
+ **station_id** | **String**| |
2091
+ {: class="table table-striped"}
2092
+
2093
+
2094
+ ### Return type
2095
+
2096
+ nil (empty response body)
2097
+
2098
+ ### HTTP request headers
2099
+
2100
+ - **Content-Type**: application/json
2101
+ - **Accept**: application/json
2102
+
2103
+
2104
+