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,15 @@
1
+ ---
2
+ title: ResponseQueryRequest
3
+ ---
4
+ ## PureCloud::ResponseQueryRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **query_phrase** | **String** | Query phrase to search response text and name. If not set will match all. | [optional] |
11
+ | **page_size** | **Integer** | The maximum number of hits to return. Default: 25, Maximum: 500. | [optional] |
12
+ | **filters** | [**Array<ResponseFilter>**](ResponseFilter.html) | Filter the query results. | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: ResponseQueryResults
3
+ ---
4
+ ## PureCloud::ResponseQueryResults
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **results** | [**ResponseEntityList**](ResponseEntityList.html) | Contains the query results | |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: ResponseSet
3
+ ---
4
+ ## PureCloud::ResponseSet
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
+ | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **version** | **Integer** | | [optional] |
15
+ | **responses** | [**Hash<String, Reaction>**](Reaction.html) | | [optional] |
16
+ | **self_uri** | **String** | The URI for this object | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: ResponseSetEntityListing
3
+ ---
4
+ ## PureCloud::ResponseSetEntityListing
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<ResponseSet>**](ResponseSet.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,14 @@
1
+ ---
2
+ title: ResponseText
3
+ ---
4
+ ## PureCloud::ResponseText
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **content** | **String** | Response text content. | |
11
+ | **content_type** | **String** | Response text content type. | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: RestErrorDetail
3
+ ---
4
+ ## PureCloud::RestErrorDetail
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **error** | **String** | | [optional] |
11
+ | **details** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: RetentionDuration
3
+ ---
4
+ ## PureCloud::RetentionDuration
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **archive_retention** | [**ArchiveRetention**](ArchiveRetention.html) | | [optional] |
11
+ | **delete_retention** | [**DeleteRetention**](DeleteRetention.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: Ring
3
+ ---
4
+ ## PureCloud::Ring
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **expansion_criteria** | [**Array<ExpansionCriterium>**](ExpansionCriterium.html) | | [optional] |
11
+ | **actions** | [**Actions**](Actions.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,2388 @@
1
+ ---
2
+ title: RoutingApi
3
+ ---
4
+
5
+ ## PureCloud::RoutingApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | HTTP request | Description
10
+ ------------- | ------------- | -------------
11
+ |[**delete_email_domains_domain_routes_id**](RoutingApi.html#delete_email_domains_domain_routes_id) | **DELETE** /api/v2/routing/email/domains/{domain}/routes/{id} | Delete a route|
12
+ |[**delete_email_domains_id**](RoutingApi.html#delete_email_domains_id) | **DELETE** /api/v2/routing/email/domains/{id} | Delete a domain|
13
+ |[**delete_queues_queue_id**](RoutingApi.html#delete_queues_queue_id) | **DELETE** /api/v2/routing/queues/{queueId} | Delete a queue|
14
+ |[**delete_queues_queue_id_users_member_id**](RoutingApi.html#delete_queues_queue_id_users_member_id) | **DELETE** /api/v2/routing/queues/{queueId}/users/{memberId} | Delete queue member|
15
+ |[**delete_queues_queue_id_wrapupcodes_code_id**](RoutingApi.html#delete_queues_queue_id_wrapupcodes_code_id) | **DELETE** /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId} | Delete a wrap-up code from a queue|
16
+ |[**delete_skills_skill_id**](RoutingApi.html#delete_skills_skill_id) | **DELETE** /api/v2/routing/skills/{skillId} | Delete Routing Skill|
17
+ |[**delete_user_id_routingskills_skill_id**](RoutingApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user|
18
+ |[**delete_utilization**](RoutingApi.html#delete_utilization) | **DELETE** /api/v2/routing/utilization | Delete utilization settings and revert to system defaults.|
19
+ |[**delete_wrapupcodes_code_id**](RoutingApi.html#delete_wrapupcodes_code_id) | **DELETE** /api/v2/routing/wrapupcodes/{codeId} | Delete wrap-up code|
20
+ |[**get_email_domains**](RoutingApi.html#get_email_domains) | **GET** /api/v2/routing/email/domains | Get domains|
21
+ |[**get_email_domains_domain_routes**](RoutingApi.html#get_email_domains_domain_routes) | **GET** /api/v2/routing/email/domains/{domain}/routes | Get routes|
22
+ |[**get_email_domains_domain_routes_id**](RoutingApi.html#get_email_domains_domain_routes_id) | **GET** /api/v2/routing/email/domains/{domain}/routes/{id} | Get a route|
23
+ |[**get_email_setup**](RoutingApi.html#get_email_setup) | **GET** /api/v2/routing/email/setup | Get email setup|
24
+ |[**get_queues**](RoutingApi.html#get_queues) | **GET** /api/v2/routing/queues | Get list of queues.|
25
+ |[**get_queues_queue_id**](RoutingApi.html#get_queues_queue_id) | **GET** /api/v2/routing/queues/{queueId} | Get details about this queue.|
26
+ |[**get_queues_queue_id_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_estimatedwaittime) | **GET** /api/v2/routing/queues/{queueId}/estimatedwaittime | Get Estimated Wait Time|
27
+ |[**get_queues_queue_id_users**](RoutingApi.html#get_queues_queue_id_users) | **GET** /api/v2/routing/queues/{queueId}/users | Get the members of this queue|
28
+ |[**get_queues_queue_id_wrapupcodes**](RoutingApi.html#get_queues_queue_id_wrapupcodes) | **GET** /api/v2/routing/queues/{queueId}/wrapupcodes | Get the wrap-up codes for a queue|
29
+ |[**get_skills**](RoutingApi.html#get_skills) | **GET** /api/v2/routing/skills | Get the list of routing skills.|
30
+ |[**get_skills_skill_id**](RoutingApi.html#get_skills_skill_id) | **GET** /api/v2/routing/skills/{skillId} | Get Routing Skill|
31
+ |[**get_user_id_routingskills**](RoutingApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user|
32
+ |[**get_utilization**](RoutingApi.html#get_utilization) | **GET** /api/v2/routing/utilization | Get the utilization settings.|
33
+ |[**get_wrapupcodes**](RoutingApi.html#get_wrapupcodes) | **GET** /api/v2/routing/wrapupcodes | Get list of wrapup codes.|
34
+ |[**get_wrapupcodes_code_id**](RoutingApi.html#get_wrapupcodes_code_id) | **GET** /api/v2/routing/wrapupcodes/{codeId} | Get details about this wrap-up code.|
35
+ |[**patch_queues_queue_id_users**](RoutingApi.html#patch_queues_queue_id_users) | **PATCH** /api/v2/routing/queues/{queueId}/users | Join or unjoin a set of users for a queue|
36
+ |[**patch_queues_queue_id_users_member_id**](RoutingApi.html#patch_queues_queue_id_users_member_id) | **PATCH** /api/v2/routing/queues/{queueId}/users/{memberId} | Update the ring number of joined status for a User in a Queue|
37
+ |[**post_email_domains**](RoutingApi.html#post_email_domains) | **POST** /api/v2/routing/email/domains | Create a domain|
38
+ |[**post_email_domains_domain_routes**](RoutingApi.html#post_email_domains_domain_routes) | **POST** /api/v2/routing/email/domains/{domain}/routes | Create a route|
39
+ |[**post_queues**](RoutingApi.html#post_queues) | **POST** /api/v2/routing/queues | Create queue|
40
+ |[**post_queues_observations_query**](RoutingApi.html#post_queues_observations_query) | **POST** /api/v2/analytics/queues/observations/query | Query for queue observations|
41
+ |[**post_queues_queue_id_users**](RoutingApi.html#post_queues_queue_id_users) | **POST** /api/v2/routing/queues/{queueId}/users | Bulk add or delete up to 100 queue members|
42
+ |[**post_queues_queue_id_wrapupcodes**](RoutingApi.html#post_queues_queue_id_wrapupcodes) | **POST** /api/v2/routing/queues/{queueId}/wrapupcodes | Add up to 100 wrap-up codes to a queue|
43
+ |[**post_skills**](RoutingApi.html#post_skills) | **POST** /api/v2/routing/skills | Create Skill|
44
+ |[**post_user_id_routingskills**](RoutingApi.html#post_user_id_routingskills) | **POST** /api/v2/users/{userId}/routingskills | Add routing skill to user|
45
+ |[**post_wrapupcodes**](RoutingApi.html#post_wrapupcodes) | **POST** /api/v2/routing/wrapupcodes | Create a wrap-up code|
46
+ |[**put_email_domains_domain_routes_id**](RoutingApi.html#put_email_domains_domain_routes_id) | **PUT** /api/v2/routing/email/domains/{domain}/routes/{id} | Update a route|
47
+ |[**put_queues_queue_id**](RoutingApi.html#put_queues_queue_id) | **PUT** /api/v2/routing/queues/{queueId} | Update a queue|
48
+ |[**put_skills_skill_id**](RoutingApi.html#put_skills_skill_id) | **PUT** /api/v2/routing/skills/{skillId} | Update Routing Skill|
49
+ |[**put_utilization**](RoutingApi.html#put_utilization) | **PUT** /api/v2/routing/utilization | Update the utilization settings.|
50
+ |[**put_wrapupcodes_code_id**](RoutingApi.html#put_wrapupcodes_code_id) | **PUT** /api/v2/routing/wrapupcodes/{codeId} | Update wrap-up code|
51
+ {: class="table table-striped"}
52
+
53
+ <a name="delete_email_domains_domain_routes_id"></a>
54
+
55
+ ## -String** delete_email_domains_domain_routes_id(domain, id)
56
+
57
+ Delete a route
58
+
59
+
60
+
61
+ ### Example
62
+ ~~~ruby
63
+ # load the gem
64
+ require 'purecloud'
65
+ # setup authorization
66
+ @secret = ENV['PURECLOUD_SECRET']
67
+ @id = ENV['PURECLOUD_CLIENT_ID']
68
+ environment = "mypurecloud.com"
69
+
70
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
71
+
72
+ PureCloud.configure do |config|
73
+ config.access_token = @authToken
74
+ end
75
+
76
+ api_instance = PureCloud::RoutingApi.new
77
+
78
+ domain = "domain_example" # String | email domain
79
+
80
+ id = "id_example" # String | route ID
81
+
82
+
83
+ begin
84
+ #Delete a route
85
+ result = api_instance.delete_email_domains_domain_routes_id(domain, id)
86
+ p result
87
+ rescue PureCloud::ApiError => e
88
+ puts "Exception when calling RoutingApi->delete_email_domains_domain_routes_id: #{e}"
89
+ end
90
+ ~~~
91
+
92
+ ### Parameters
93
+
94
+ Name | Type | Description | Notes
95
+ ------------- | ------------- | ------------- | -------------
96
+ **domain** | **String**| email domain |
97
+ **id** | **String**| route ID |
98
+ {: class="table table-striped"}
99
+
100
+
101
+ ### Return type
102
+
103
+ **String**
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: application/json
108
+ - **Accept**: application/json
109
+
110
+
111
+
112
+ <a name="delete_email_domains_id"></a>
113
+
114
+ ## -String** delete_email_domains_id(id)
115
+
116
+ Delete a domain
117
+
118
+
119
+
120
+ ### Example
121
+ ~~~ruby
122
+ # load the gem
123
+ require 'purecloud'
124
+ # setup authorization
125
+ @secret = ENV['PURECLOUD_SECRET']
126
+ @id = ENV['PURECLOUD_CLIENT_ID']
127
+ environment = "mypurecloud.com"
128
+
129
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
130
+
131
+ PureCloud.configure do |config|
132
+ config.access_token = @authToken
133
+ end
134
+
135
+ api_instance = PureCloud::RoutingApi.new
136
+
137
+ id = "id_example" # String | domain ID
138
+
139
+
140
+ begin
141
+ #Delete a domain
142
+ result = api_instance.delete_email_domains_id(id)
143
+ p result
144
+ rescue PureCloud::ApiError => e
145
+ puts "Exception when calling RoutingApi->delete_email_domains_id: #{e}"
146
+ end
147
+ ~~~
148
+
149
+ ### Parameters
150
+
151
+ Name | Type | Description | Notes
152
+ ------------- | ------------- | ------------- | -------------
153
+ **id** | **String**| domain ID |
154
+ {: class="table table-striped"}
155
+
156
+
157
+ ### Return type
158
+
159
+ **String**
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/json
164
+ - **Accept**: application/json
165
+
166
+
167
+
168
+ <a name="delete_queues_queue_id"></a>
169
+
170
+ ## -String** delete_queues_queue_id(queue_id, opts)
171
+
172
+ Delete a queue
173
+
174
+
175
+
176
+ ### Example
177
+ ~~~ruby
178
+ # load the gem
179
+ require 'purecloud'
180
+ # setup authorization
181
+ @secret = ENV['PURECLOUD_SECRET']
182
+ @id = ENV['PURECLOUD_CLIENT_ID']
183
+ environment = "mypurecloud.com"
184
+
185
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
186
+
187
+ PureCloud.configure do |config|
188
+ config.access_token = @authToken
189
+ end
190
+
191
+ api_instance = PureCloud::RoutingApi.new
192
+
193
+ queue_id = "queue_id_example" # String | Queue ID
194
+
195
+ opts = {
196
+ force_delete: true # BOOLEAN |
197
+ }
198
+
199
+ begin
200
+ #Delete a queue
201
+ result = api_instance.delete_queues_queue_id(queue_id, opts)
202
+ p result
203
+ rescue PureCloud::ApiError => e
204
+ puts "Exception when calling RoutingApi->delete_queues_queue_id: #{e}"
205
+ end
206
+ ~~~
207
+
208
+ ### Parameters
209
+
210
+ Name | Type | Description | Notes
211
+ ------------- | ------------- | ------------- | -------------
212
+ **queue_id** | **String**| Queue ID |
213
+ **force_delete** | **BOOLEAN**| | [optional]
214
+ {: class="table table-striped"}
215
+
216
+
217
+ ### Return type
218
+
219
+ **String**
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: application/json
224
+ - **Accept**: application/json
225
+
226
+
227
+
228
+ <a name="delete_queues_queue_id_users_member_id"></a>
229
+
230
+ ## -String** delete_queues_queue_id_users_member_id(queue_id, member_id)
231
+
232
+ Delete queue member
233
+
234
+
235
+
236
+ ### Example
237
+ ~~~ruby
238
+ # load the gem
239
+ require 'purecloud'
240
+ # setup authorization
241
+ @secret = ENV['PURECLOUD_SECRET']
242
+ @id = ENV['PURECLOUD_CLIENT_ID']
243
+ environment = "mypurecloud.com"
244
+
245
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
246
+
247
+ PureCloud.configure do |config|
248
+ config.access_token = @authToken
249
+ end
250
+
251
+ api_instance = PureCloud::RoutingApi.new
252
+
253
+ queue_id = "queue_id_example" # String | Queue ID
254
+
255
+ member_id = "member_id_example" # String | Member ID
256
+
257
+
258
+ begin
259
+ #Delete queue member
260
+ result = api_instance.delete_queues_queue_id_users_member_id(queue_id, member_id)
261
+ p result
262
+ rescue PureCloud::ApiError => e
263
+ puts "Exception when calling RoutingApi->delete_queues_queue_id_users_member_id: #{e}"
264
+ end
265
+ ~~~
266
+
267
+ ### Parameters
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **queue_id** | **String**| Queue ID |
272
+ **member_id** | **String**| Member ID |
273
+ {: class="table table-striped"}
274
+
275
+
276
+ ### Return type
277
+
278
+ **String**
279
+
280
+ ### HTTP request headers
281
+
282
+ - **Content-Type**: application/json
283
+ - **Accept**: application/json
284
+
285
+
286
+
287
+ <a name="delete_queues_queue_id_wrapupcodes_code_id"></a>
288
+
289
+ ## -String** delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id)
290
+
291
+ Delete a wrap-up code from a queue
292
+
293
+
294
+
295
+ ### Example
296
+ ~~~ruby
297
+ # load the gem
298
+ require 'purecloud'
299
+ # setup authorization
300
+ @secret = ENV['PURECLOUD_SECRET']
301
+ @id = ENV['PURECLOUD_CLIENT_ID']
302
+ environment = "mypurecloud.com"
303
+
304
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
305
+
306
+ PureCloud.configure do |config|
307
+ config.access_token = @authToken
308
+ end
309
+
310
+ api_instance = PureCloud::RoutingApi.new
311
+
312
+ queue_id = "queue_id_example" # String | Queue ID
313
+
314
+ code_id = "code_id_example" # String | Code ID
315
+
316
+
317
+ begin
318
+ #Delete a wrap-up code from a queue
319
+ result = api_instance.delete_queues_queue_id_wrapupcodes_code_id(queue_id, code_id)
320
+ p result
321
+ rescue PureCloud::ApiError => e
322
+ puts "Exception when calling RoutingApi->delete_queues_queue_id_wrapupcodes_code_id: #{e}"
323
+ end
324
+ ~~~
325
+
326
+ ### Parameters
327
+
328
+ Name | Type | Description | Notes
329
+ ------------- | ------------- | ------------- | -------------
330
+ **queue_id** | **String**| Queue ID |
331
+ **code_id** | **String**| Code ID |
332
+ {: class="table table-striped"}
333
+
334
+
335
+ ### Return type
336
+
337
+ **String**
338
+
339
+ ### HTTP request headers
340
+
341
+ - **Content-Type**: application/json
342
+ - **Accept**: application/json
343
+
344
+
345
+
346
+ <a name="delete_skills_skill_id"></a>
347
+
348
+ ## -String** delete_skills_skill_id(skill_id)
349
+
350
+ Delete Routing Skill
351
+
352
+
353
+
354
+ ### Example
355
+ ~~~ruby
356
+ # load the gem
357
+ require 'purecloud'
358
+ # setup authorization
359
+ @secret = ENV['PURECLOUD_SECRET']
360
+ @id = ENV['PURECLOUD_CLIENT_ID']
361
+ environment = "mypurecloud.com"
362
+
363
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
364
+
365
+ PureCloud.configure do |config|
366
+ config.access_token = @authToken
367
+ end
368
+
369
+ api_instance = PureCloud::RoutingApi.new
370
+
371
+ skill_id = "skill_id_example" # String | Skill ID
372
+
373
+
374
+ begin
375
+ #Delete Routing Skill
376
+ result = api_instance.delete_skills_skill_id(skill_id)
377
+ p result
378
+ rescue PureCloud::ApiError => e
379
+ puts "Exception when calling RoutingApi->delete_skills_skill_id: #{e}"
380
+ end
381
+ ~~~
382
+
383
+ ### Parameters
384
+
385
+ Name | Type | Description | Notes
386
+ ------------- | ------------- | ------------- | -------------
387
+ **skill_id** | **String**| Skill ID |
388
+ {: class="table table-striped"}
389
+
390
+
391
+ ### Return type
392
+
393
+ **String**
394
+
395
+ ### HTTP request headers
396
+
397
+ - **Content-Type**: application/json
398
+ - **Accept**: application/json
399
+
400
+
401
+
402
+ <a name="delete_user_id_routingskills_skill_id"></a>
403
+
404
+ ## -String** delete_user_id_routingskills_skill_id(user_id, skill_id)
405
+
406
+ Remove routing skill from user
407
+
408
+
409
+
410
+ ### Example
411
+ ~~~ruby
412
+ # load the gem
413
+ require 'purecloud'
414
+ # setup authorization
415
+ @secret = ENV['PURECLOUD_SECRET']
416
+ @id = ENV['PURECLOUD_CLIENT_ID']
417
+ environment = "mypurecloud.com"
418
+
419
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
420
+
421
+ PureCloud.configure do |config|
422
+ config.access_token = @authToken
423
+ end
424
+
425
+ api_instance = PureCloud::RoutingApi.new
426
+
427
+ user_id = "user_id_example" # String | User ID
428
+
429
+ skill_id = "skill_id_example" # String |
430
+
431
+
432
+ begin
433
+ #Remove routing skill from user
434
+ result = api_instance.delete_user_id_routingskills_skill_id(user_id, skill_id)
435
+ p result
436
+ rescue PureCloud::ApiError => e
437
+ puts "Exception when calling RoutingApi->delete_user_id_routingskills_skill_id: #{e}"
438
+ end
439
+ ~~~
440
+
441
+ ### Parameters
442
+
443
+ Name | Type | Description | Notes
444
+ ------------- | ------------- | ------------- | -------------
445
+ **user_id** | **String**| User ID |
446
+ **skill_id** | **String**| |
447
+ {: class="table table-striped"}
448
+
449
+
450
+ ### Return type
451
+
452
+ **String**
453
+
454
+ ### HTTP request headers
455
+
456
+ - **Content-Type**: application/json
457
+ - **Accept**: application/json
458
+
459
+
460
+
461
+ <a name="delete_utilization"></a>
462
+
463
+ ## -String** delete_utilization
464
+
465
+ Delete utilization settings and revert to system defaults.
466
+
467
+
468
+
469
+ ### Example
470
+ ~~~ruby
471
+ # load the gem
472
+ require 'purecloud'
473
+ # setup authorization
474
+ @secret = ENV['PURECLOUD_SECRET']
475
+ @id = ENV['PURECLOUD_CLIENT_ID']
476
+ environment = "mypurecloud.com"
477
+
478
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
479
+
480
+ PureCloud.configure do |config|
481
+ config.access_token = @authToken
482
+ end
483
+
484
+ api_instance = PureCloud::RoutingApi.new
485
+
486
+ begin
487
+ #Delete utilization settings and revert to system defaults.
488
+ result = api_instance.delete_utilization
489
+ p result
490
+ rescue PureCloud::ApiError => e
491
+ puts "Exception when calling RoutingApi->delete_utilization: #{e}"
492
+ end
493
+ ~~~
494
+
495
+ ### Parameters
496
+ This endpoint does not need any parameter.
497
+ {: class="table table-striped"}
498
+
499
+
500
+ ### Return type
501
+
502
+ **String**
503
+
504
+ ### HTTP request headers
505
+
506
+ - **Content-Type**: application/json
507
+ - **Accept**: application/json
508
+
509
+
510
+
511
+ <a name="delete_wrapupcodes_code_id"></a>
512
+
513
+ ## -String** delete_wrapupcodes_code_id(code_id)
514
+
515
+ Delete wrap-up code
516
+
517
+
518
+
519
+ ### Example
520
+ ~~~ruby
521
+ # load the gem
522
+ require 'purecloud'
523
+ # setup authorization
524
+ @secret = ENV['PURECLOUD_SECRET']
525
+ @id = ENV['PURECLOUD_CLIENT_ID']
526
+ environment = "mypurecloud.com"
527
+
528
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
529
+
530
+ PureCloud.configure do |config|
531
+ config.access_token = @authToken
532
+ end
533
+
534
+ api_instance = PureCloud::RoutingApi.new
535
+
536
+ code_id = "code_id_example" # String | Wrapup Code ID
537
+
538
+
539
+ begin
540
+ #Delete wrap-up code
541
+ result = api_instance.delete_wrapupcodes_code_id(code_id)
542
+ p result
543
+ rescue PureCloud::ApiError => e
544
+ puts "Exception when calling RoutingApi->delete_wrapupcodes_code_id: #{e}"
545
+ end
546
+ ~~~
547
+
548
+ ### Parameters
549
+
550
+ Name | Type | Description | Notes
551
+ ------------- | ------------- | ------------- | -------------
552
+ **code_id** | **String**| Wrapup Code ID |
553
+ {: class="table table-striped"}
554
+
555
+
556
+ ### Return type
557
+
558
+ **String**
559
+
560
+ ### HTTP request headers
561
+
562
+ - **Content-Type**: application/json
563
+ - **Accept**: application/json
564
+
565
+
566
+
567
+ <a name="get_email_domains"></a>
568
+
569
+ ## -[**InboundDomainEntityListing**](InboundDomainEntityListing.html) get_email_domains
570
+
571
+ Get domains
572
+
573
+
574
+
575
+ ### Example
576
+ ~~~ruby
577
+ # load the gem
578
+ require 'purecloud'
579
+ # setup authorization
580
+ @secret = ENV['PURECLOUD_SECRET']
581
+ @id = ENV['PURECLOUD_CLIENT_ID']
582
+ environment = "mypurecloud.com"
583
+
584
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
585
+
586
+ PureCloud.configure do |config|
587
+ config.access_token = @authToken
588
+ end
589
+
590
+ api_instance = PureCloud::RoutingApi.new
591
+
592
+ begin
593
+ #Get domains
594
+ result = api_instance.get_email_domains
595
+ p result
596
+ rescue PureCloud::ApiError => e
597
+ puts "Exception when calling RoutingApi->get_email_domains: #{e}"
598
+ end
599
+ ~~~
600
+
601
+ ### Parameters
602
+ This endpoint does not need any parameter.
603
+ {: class="table table-striped"}
604
+
605
+
606
+ ### Return type
607
+
608
+ [**InboundDomainEntityListing**](InboundDomainEntityListing.html)
609
+
610
+ ### HTTP request headers
611
+
612
+ - **Content-Type**: application/json
613
+ - **Accept**: application/json
614
+
615
+
616
+
617
+ <a name="get_email_domains_domain_routes"></a>
618
+
619
+ ## -[**InboundRouteEntityListing**](InboundRouteEntityListing.html) get_email_domains_domain_routes(domain)
620
+
621
+ Get routes
622
+
623
+
624
+
625
+ ### Example
626
+ ~~~ruby
627
+ # load the gem
628
+ require 'purecloud'
629
+ # setup authorization
630
+ @secret = ENV['PURECLOUD_SECRET']
631
+ @id = ENV['PURECLOUD_CLIENT_ID']
632
+ environment = "mypurecloud.com"
633
+
634
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
635
+
636
+ PureCloud.configure do |config|
637
+ config.access_token = @authToken
638
+ end
639
+
640
+ api_instance = PureCloud::RoutingApi.new
641
+
642
+ domain = "domain_example" # String | email domain
643
+
644
+
645
+ begin
646
+ #Get routes
647
+ result = api_instance.get_email_domains_domain_routes(domain)
648
+ p result
649
+ rescue PureCloud::ApiError => e
650
+ puts "Exception when calling RoutingApi->get_email_domains_domain_routes: #{e}"
651
+ end
652
+ ~~~
653
+
654
+ ### Parameters
655
+
656
+ Name | Type | Description | Notes
657
+ ------------- | ------------- | ------------- | -------------
658
+ **domain** | **String**| email domain |
659
+ {: class="table table-striped"}
660
+
661
+
662
+ ### Return type
663
+
664
+ [**InboundRouteEntityListing**](InboundRouteEntityListing.html)
665
+
666
+ ### HTTP request headers
667
+
668
+ - **Content-Type**: application/json
669
+ - **Accept**: application/json
670
+
671
+
672
+
673
+ <a name="get_email_domains_domain_routes_id"></a>
674
+
675
+ ## -[**InboundRoute**](InboundRoute.html) get_email_domains_domain_routes_id(domain, id)
676
+
677
+ Get a route
678
+
679
+
680
+
681
+ ### Example
682
+ ~~~ruby
683
+ # load the gem
684
+ require 'purecloud'
685
+ # setup authorization
686
+ @secret = ENV['PURECLOUD_SECRET']
687
+ @id = ENV['PURECLOUD_CLIENT_ID']
688
+ environment = "mypurecloud.com"
689
+
690
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
691
+
692
+ PureCloud.configure do |config|
693
+ config.access_token = @authToken
694
+ end
695
+
696
+ api_instance = PureCloud::RoutingApi.new
697
+
698
+ domain = "domain_example" # String | email domain
699
+
700
+ id = "id_example" # String | route ID
701
+
702
+
703
+ begin
704
+ #Get a route
705
+ result = api_instance.get_email_domains_domain_routes_id(domain, id)
706
+ p result
707
+ rescue PureCloud::ApiError => e
708
+ puts "Exception when calling RoutingApi->get_email_domains_domain_routes_id: #{e}"
709
+ end
710
+ ~~~
711
+
712
+ ### Parameters
713
+
714
+ Name | Type | Description | Notes
715
+ ------------- | ------------- | ------------- | -------------
716
+ **domain** | **String**| email domain |
717
+ **id** | **String**| route ID |
718
+ {: class="table table-striped"}
719
+
720
+
721
+ ### Return type
722
+
723
+ [**InboundRoute**](InboundRoute.html)
724
+
725
+ ### HTTP request headers
726
+
727
+ - **Content-Type**: application/json
728
+ - **Accept**: application/json
729
+
730
+
731
+
732
+ <a name="get_email_setup"></a>
733
+
734
+ ## -[**EmailSetup**](EmailSetup.html) get_email_setup
735
+
736
+ Get email setup
737
+
738
+
739
+
740
+ ### Example
741
+ ~~~ruby
742
+ # load the gem
743
+ require 'purecloud'
744
+ # setup authorization
745
+ @secret = ENV['PURECLOUD_SECRET']
746
+ @id = ENV['PURECLOUD_CLIENT_ID']
747
+ environment = "mypurecloud.com"
748
+
749
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
750
+
751
+ PureCloud.configure do |config|
752
+ config.access_token = @authToken
753
+ end
754
+
755
+ api_instance = PureCloud::RoutingApi.new
756
+
757
+ begin
758
+ #Get email setup
759
+ result = api_instance.get_email_setup
760
+ p result
761
+ rescue PureCloud::ApiError => e
762
+ puts "Exception when calling RoutingApi->get_email_setup: #{e}"
763
+ end
764
+ ~~~
765
+
766
+ ### Parameters
767
+ This endpoint does not need any parameter.
768
+ {: class="table table-striped"}
769
+
770
+
771
+ ### Return type
772
+
773
+ [**EmailSetup**](EmailSetup.html)
774
+
775
+ ### HTTP request headers
776
+
777
+ - **Content-Type**: application/json
778
+ - **Accept**: application/json
779
+
780
+
781
+
782
+ <a name="get_queues"></a>
783
+
784
+ ## -[**QueueEntityListing**](QueueEntityListing.html) get_queues(opts)
785
+
786
+ Get list of queues.
787
+
788
+
789
+
790
+ ### Example
791
+ ~~~ruby
792
+ # load the gem
793
+ require 'purecloud'
794
+ # setup authorization
795
+ @secret = ENV['PURECLOUD_SECRET']
796
+ @id = ENV['PURECLOUD_CLIENT_ID']
797
+ environment = "mypurecloud.com"
798
+
799
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
800
+
801
+ PureCloud.configure do |config|
802
+ config.access_token = @authToken
803
+ end
804
+
805
+ api_instance = PureCloud::RoutingApi.new
806
+
807
+ opts = {
808
+ page_size: 25, # Integer | Page size
809
+ page_number: 1, # Integer | Page number
810
+ sort_by: "name", # String | Sort by
811
+ name: "name_example", # String | Name
812
+ active: true # BOOLEAN | Active
813
+ }
814
+
815
+ begin
816
+ #Get list of queues.
817
+ result = api_instance.get_queues(opts)
818
+ p result
819
+ rescue PureCloud::ApiError => e
820
+ puts "Exception when calling RoutingApi->get_queues: #{e}"
821
+ end
822
+ ~~~
823
+
824
+ ### Parameters
825
+
826
+ Name | Type | Description | Notes
827
+ ------------- | ------------- | ------------- | -------------
828
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
829
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
830
+ **sort_by** | **String**| Sort by | [optional] [default to name]
831
+ **name** | **String**| Name | [optional]
832
+ **active** | **BOOLEAN**| Active | [optional]
833
+ {: class="table table-striped"}
834
+
835
+
836
+ ### Return type
837
+
838
+ [**QueueEntityListing**](QueueEntityListing.html)
839
+
840
+ ### HTTP request headers
841
+
842
+ - **Content-Type**: application/json
843
+ - **Accept**: application/json
844
+
845
+
846
+
847
+ <a name="get_queues_queue_id"></a>
848
+
849
+ ## -[**Queue**](Queue.html) get_queues_queue_id(queue_id)
850
+
851
+ Get details about this queue.
852
+
853
+
854
+
855
+ ### Example
856
+ ~~~ruby
857
+ # load the gem
858
+ require 'purecloud'
859
+ # setup authorization
860
+ @secret = ENV['PURECLOUD_SECRET']
861
+ @id = ENV['PURECLOUD_CLIENT_ID']
862
+ environment = "mypurecloud.com"
863
+
864
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
865
+
866
+ PureCloud.configure do |config|
867
+ config.access_token = @authToken
868
+ end
869
+
870
+ api_instance = PureCloud::RoutingApi.new
871
+
872
+ queue_id = "queue_id_example" # String | Queue ID
873
+
874
+
875
+ begin
876
+ #Get details about this queue.
877
+ result = api_instance.get_queues_queue_id(queue_id)
878
+ p result
879
+ rescue PureCloud::ApiError => e
880
+ puts "Exception when calling RoutingApi->get_queues_queue_id: #{e}"
881
+ end
882
+ ~~~
883
+
884
+ ### Parameters
885
+
886
+ Name | Type | Description | Notes
887
+ ------------- | ------------- | ------------- | -------------
888
+ **queue_id** | **String**| Queue ID |
889
+ {: class="table table-striped"}
890
+
891
+
892
+ ### Return type
893
+
894
+ [**Queue**](Queue.html)
895
+
896
+ ### HTTP request headers
897
+
898
+ - **Content-Type**: application/json
899
+ - **Accept**: application/json
900
+
901
+
902
+
903
+ <a name="get_queues_queue_id_estimatedwaittime"></a>
904
+
905
+ ## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_queues_queue_id_estimatedwaittime(queue_id, opts)
906
+
907
+ Get Estimated Wait Time
908
+
909
+
910
+
911
+ ### Example
912
+ ~~~ruby
913
+ # load the gem
914
+ require 'purecloud'
915
+ # setup authorization
916
+ @secret = ENV['PURECLOUD_SECRET']
917
+ @id = ENV['PURECLOUD_CLIENT_ID']
918
+ environment = "mypurecloud.com"
919
+
920
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
921
+
922
+ PureCloud.configure do |config|
923
+ config.access_token = @authToken
924
+ end
925
+
926
+ api_instance = PureCloud::RoutingApi.new
927
+
928
+ queue_id = "queue_id_example" # String | queueId
929
+
930
+ opts = {
931
+ conversation_id: "conversation_id_example" # String | conversationId
932
+ }
933
+
934
+ begin
935
+ #Get Estimated Wait Time
936
+ result = api_instance.get_queues_queue_id_estimatedwaittime(queue_id, opts)
937
+ p result
938
+ rescue PureCloud::ApiError => e
939
+ puts "Exception when calling RoutingApi->get_queues_queue_id_estimatedwaittime: #{e}"
940
+ end
941
+ ~~~
942
+
943
+ ### Parameters
944
+
945
+ Name | Type | Description | Notes
946
+ ------------- | ------------- | ------------- | -------------
947
+ **queue_id** | **String**| queueId |
948
+ **conversation_id** | **String**| conversationId | [optional]
949
+ {: class="table table-striped"}
950
+
951
+
952
+ ### Return type
953
+
954
+ [**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html)
955
+
956
+ ### HTTP request headers
957
+
958
+ - **Content-Type**: application/json
959
+ - **Accept**: application/json
960
+
961
+
962
+
963
+ <a name="get_queues_queue_id_users"></a>
964
+
965
+ ## -[**QueueMember**](QueueMember.html) get_queues_queue_id_users(queue_id, opts)
966
+
967
+ Get the members of this queue
968
+
969
+
970
+
971
+ ### Example
972
+ ~~~ruby
973
+ # load the gem
974
+ require 'purecloud'
975
+ # setup authorization
976
+ @secret = ENV['PURECLOUD_SECRET']
977
+ @id = ENV['PURECLOUD_CLIENT_ID']
978
+ environment = "mypurecloud.com"
979
+
980
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
981
+
982
+ PureCloud.configure do |config|
983
+ config.access_token = @authToken
984
+ end
985
+
986
+ api_instance = PureCloud::RoutingApi.new
987
+
988
+ queue_id = "queue_id_example" # String | Queue ID
989
+
990
+ opts = {
991
+ page_size: 25, # Integer | Page size
992
+ page_number: 1, # Integer | Page number
993
+ sort_by: "name", # String | Sort by
994
+ expand: "expand_example", # String | expand
995
+ direct_members: false # BOOLEAN | Only get users that are direct members of the queue
996
+ }
997
+
998
+ begin
999
+ #Get the members of this queue
1000
+ result = api_instance.get_queues_queue_id_users(queue_id, opts)
1001
+ p result
1002
+ rescue PureCloud::ApiError => e
1003
+ puts "Exception when calling RoutingApi->get_queues_queue_id_users: #{e}"
1004
+ end
1005
+ ~~~
1006
+
1007
+ ### Parameters
1008
+
1009
+ Name | Type | Description | Notes
1010
+ ------------- | ------------- | ------------- | -------------
1011
+ **queue_id** | **String**| Queue ID |
1012
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1013
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1014
+ **sort_by** | **String**| Sort by | [optional] [default to name]
1015
+ **expand** | **String**| expand | [optional]
1016
+ **direct_members** | **BOOLEAN**| Only get users that are direct members of the queue | [optional] [default to false]
1017
+ {: class="table table-striped"}
1018
+
1019
+
1020
+ ### Return type
1021
+
1022
+ [**QueueMember**](QueueMember.html)
1023
+
1024
+ ### HTTP request headers
1025
+
1026
+ - **Content-Type**: application/json
1027
+ - **Accept**: application/json
1028
+
1029
+
1030
+
1031
+ <a name="get_queues_queue_id_wrapupcodes"></a>
1032
+
1033
+ ## -[**WrapupCode**](WrapupCode.html) get_queues_queue_id_wrapupcodes(queue_id, code_id)
1034
+
1035
+ Get the wrap-up codes for a queue
1036
+
1037
+
1038
+
1039
+ ### Example
1040
+ ~~~ruby
1041
+ # load the gem
1042
+ require 'purecloud'
1043
+ # setup authorization
1044
+ @secret = ENV['PURECLOUD_SECRET']
1045
+ @id = ENV['PURECLOUD_CLIENT_ID']
1046
+ environment = "mypurecloud.com"
1047
+
1048
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1049
+
1050
+ PureCloud.configure do |config|
1051
+ config.access_token = @authToken
1052
+ end
1053
+
1054
+ api_instance = PureCloud::RoutingApi.new
1055
+
1056
+ queue_id = "queue_id_example" # String | Queue ID
1057
+
1058
+ code_id = "code_id_example" # String | Code ID
1059
+
1060
+
1061
+ begin
1062
+ #Get the wrap-up codes for a queue
1063
+ result = api_instance.get_queues_queue_id_wrapupcodes(queue_id, code_id)
1064
+ p result
1065
+ rescue PureCloud::ApiError => e
1066
+ puts "Exception when calling RoutingApi->get_queues_queue_id_wrapupcodes: #{e}"
1067
+ end
1068
+ ~~~
1069
+
1070
+ ### Parameters
1071
+
1072
+ Name | Type | Description | Notes
1073
+ ------------- | ------------- | ------------- | -------------
1074
+ **queue_id** | **String**| Queue ID |
1075
+ **code_id** | **String**| Code ID |
1076
+ {: class="table table-striped"}
1077
+
1078
+
1079
+ ### Return type
1080
+
1081
+ [**WrapupCode**](WrapupCode.html)
1082
+
1083
+ ### HTTP request headers
1084
+
1085
+ - **Content-Type**: application/json
1086
+ - **Accept**: application/json
1087
+
1088
+
1089
+
1090
+ <a name="get_skills"></a>
1091
+
1092
+ ## -[**SkillEntityListing**](SkillEntityListing.html) get_skills(opts)
1093
+
1094
+ Get the list of routing skills.
1095
+
1096
+
1097
+
1098
+ ### Example
1099
+ ~~~ruby
1100
+ # load the gem
1101
+ require 'purecloud'
1102
+ # setup authorization
1103
+ @secret = ENV['PURECLOUD_SECRET']
1104
+ @id = ENV['PURECLOUD_CLIENT_ID']
1105
+ environment = "mypurecloud.com"
1106
+
1107
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1108
+
1109
+ PureCloud.configure do |config|
1110
+ config.access_token = @authToken
1111
+ end
1112
+
1113
+ api_instance = PureCloud::RoutingApi.new
1114
+
1115
+ opts = {
1116
+ page_size: 25, # Integer | Page size
1117
+ page_number: 1 # Integer | Page number
1118
+ }
1119
+
1120
+ begin
1121
+ #Get the list of routing skills.
1122
+ result = api_instance.get_skills(opts)
1123
+ p result
1124
+ rescue PureCloud::ApiError => e
1125
+ puts "Exception when calling RoutingApi->get_skills: #{e}"
1126
+ end
1127
+ ~~~
1128
+
1129
+ ### Parameters
1130
+
1131
+ Name | Type | Description | Notes
1132
+ ------------- | ------------- | ------------- | -------------
1133
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1134
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1135
+ {: class="table table-striped"}
1136
+
1137
+
1138
+ ### Return type
1139
+
1140
+ [**SkillEntityListing**](SkillEntityListing.html)
1141
+
1142
+ ### HTTP request headers
1143
+
1144
+ - **Content-Type**: application/json
1145
+ - **Accept**: application/json
1146
+
1147
+
1148
+
1149
+ <a name="get_skills_skill_id"></a>
1150
+
1151
+ ## -[**RoutingSkill**](RoutingSkill.html) get_skills_skill_id(skill_id)
1152
+
1153
+ Get Routing Skill
1154
+
1155
+
1156
+
1157
+ ### Example
1158
+ ~~~ruby
1159
+ # load the gem
1160
+ require 'purecloud'
1161
+ # setup authorization
1162
+ @secret = ENV['PURECLOUD_SECRET']
1163
+ @id = ENV['PURECLOUD_CLIENT_ID']
1164
+ environment = "mypurecloud.com"
1165
+
1166
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1167
+
1168
+ PureCloud.configure do |config|
1169
+ config.access_token = @authToken
1170
+ end
1171
+
1172
+ api_instance = PureCloud::RoutingApi.new
1173
+
1174
+ skill_id = "skill_id_example" # String | Skill ID
1175
+
1176
+
1177
+ begin
1178
+ #Get Routing Skill
1179
+ result = api_instance.get_skills_skill_id(skill_id)
1180
+ p result
1181
+ rescue PureCloud::ApiError => e
1182
+ puts "Exception when calling RoutingApi->get_skills_skill_id: #{e}"
1183
+ end
1184
+ ~~~
1185
+
1186
+ ### Parameters
1187
+
1188
+ Name | Type | Description | Notes
1189
+ ------------- | ------------- | ------------- | -------------
1190
+ **skill_id** | **String**| Skill ID |
1191
+ {: class="table table-striped"}
1192
+
1193
+
1194
+ ### Return type
1195
+
1196
+ [**RoutingSkill**](RoutingSkill.html)
1197
+
1198
+ ### HTTP request headers
1199
+
1200
+ - **Content-Type**: application/json
1201
+ - **Accept**: application/json
1202
+
1203
+
1204
+
1205
+ <a name="get_user_id_routingskills"></a>
1206
+
1207
+ ## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_id_routingskills(user_id, opts)
1208
+
1209
+ List routing skills for user
1210
+
1211
+
1212
+
1213
+ ### Example
1214
+ ~~~ruby
1215
+ # load the gem
1216
+ require 'purecloud'
1217
+ # setup authorization
1218
+ @secret = ENV['PURECLOUD_SECRET']
1219
+ @id = ENV['PURECLOUD_CLIENT_ID']
1220
+ environment = "mypurecloud.com"
1221
+
1222
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1223
+
1224
+ PureCloud.configure do |config|
1225
+ config.access_token = @authToken
1226
+ end
1227
+
1228
+ api_instance = PureCloud::RoutingApi.new
1229
+
1230
+ user_id = "user_id_example" # String | User ID
1231
+
1232
+ opts = {
1233
+ page_size: 25, # Integer | Page size
1234
+ page_number: 1, # Integer | Page number
1235
+ sort_order: "ASC" # String | Ascending or descending sort order
1236
+ }
1237
+
1238
+ begin
1239
+ #List routing skills for user
1240
+ result = api_instance.get_user_id_routingskills(user_id, opts)
1241
+ p result
1242
+ rescue PureCloud::ApiError => e
1243
+ puts "Exception when calling RoutingApi->get_user_id_routingskills: #{e}"
1244
+ end
1245
+ ~~~
1246
+
1247
+ ### Parameters
1248
+
1249
+ Name | Type | Description | Notes
1250
+ ------------- | ------------- | ------------- | -------------
1251
+ **user_id** | **String**| User ID |
1252
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1253
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1254
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
1255
+ {: class="table table-striped"}
1256
+
1257
+
1258
+ ### Return type
1259
+
1260
+ [**UserSkillEntityListing**](UserSkillEntityListing.html)
1261
+
1262
+ ### HTTP request headers
1263
+
1264
+ - **Content-Type**: application/json
1265
+ - **Accept**: application/json
1266
+
1267
+
1268
+
1269
+ <a name="get_utilization"></a>
1270
+
1271
+ ## -[**Utilization**](Utilization.html) get_utilization
1272
+
1273
+ Get the utilization settings.
1274
+
1275
+
1276
+
1277
+ ### Example
1278
+ ~~~ruby
1279
+ # load the gem
1280
+ require 'purecloud'
1281
+ # setup authorization
1282
+ @secret = ENV['PURECLOUD_SECRET']
1283
+ @id = ENV['PURECLOUD_CLIENT_ID']
1284
+ environment = "mypurecloud.com"
1285
+
1286
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1287
+
1288
+ PureCloud.configure do |config|
1289
+ config.access_token = @authToken
1290
+ end
1291
+
1292
+ api_instance = PureCloud::RoutingApi.new
1293
+
1294
+ begin
1295
+ #Get the utilization settings.
1296
+ result = api_instance.get_utilization
1297
+ p result
1298
+ rescue PureCloud::ApiError => e
1299
+ puts "Exception when calling RoutingApi->get_utilization: #{e}"
1300
+ end
1301
+ ~~~
1302
+
1303
+ ### Parameters
1304
+ This endpoint does not need any parameter.
1305
+ {: class="table table-striped"}
1306
+
1307
+
1308
+ ### Return type
1309
+
1310
+ [**Utilization**](Utilization.html)
1311
+
1312
+ ### HTTP request headers
1313
+
1314
+ - **Content-Type**: application/json
1315
+ - **Accept**: application/json
1316
+
1317
+
1318
+
1319
+ <a name="get_wrapupcodes"></a>
1320
+
1321
+ ## -[**WrapupCodeEntityListing**](WrapupCodeEntityListing.html) get_wrapupcodes(opts)
1322
+
1323
+ Get list of wrapup codes.
1324
+
1325
+
1326
+
1327
+ ### Example
1328
+ ~~~ruby
1329
+ # load the gem
1330
+ require 'purecloud'
1331
+ # setup authorization
1332
+ @secret = ENV['PURECLOUD_SECRET']
1333
+ @id = ENV['PURECLOUD_CLIENT_ID']
1334
+ environment = "mypurecloud.com"
1335
+
1336
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1337
+
1338
+ PureCloud.configure do |config|
1339
+ config.access_token = @authToken
1340
+ end
1341
+
1342
+ api_instance = PureCloud::RoutingApi.new
1343
+
1344
+ opts = {
1345
+ page_size: 25, # Integer | Page size
1346
+ page_number: 1, # Integer | Page number
1347
+ sort_by: "name" # String | Sort by
1348
+ }
1349
+
1350
+ begin
1351
+ #Get list of wrapup codes.
1352
+ result = api_instance.get_wrapupcodes(opts)
1353
+ p result
1354
+ rescue PureCloud::ApiError => e
1355
+ puts "Exception when calling RoutingApi->get_wrapupcodes: #{e}"
1356
+ end
1357
+ ~~~
1358
+
1359
+ ### Parameters
1360
+
1361
+ Name | Type | Description | Notes
1362
+ ------------- | ------------- | ------------- | -------------
1363
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
1364
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
1365
+ **sort_by** | **String**| Sort by | [optional] [default to name]
1366
+ {: class="table table-striped"}
1367
+
1368
+
1369
+ ### Return type
1370
+
1371
+ [**WrapupCodeEntityListing**](WrapupCodeEntityListing.html)
1372
+
1373
+ ### HTTP request headers
1374
+
1375
+ - **Content-Type**: application/json
1376
+ - **Accept**: application/json
1377
+
1378
+
1379
+
1380
+ <a name="get_wrapupcodes_code_id"></a>
1381
+
1382
+ ## -[**WrapupCode**](WrapupCode.html) get_wrapupcodes_code_id(code_id)
1383
+
1384
+ Get details about this wrap-up code.
1385
+
1386
+
1387
+
1388
+ ### Example
1389
+ ~~~ruby
1390
+ # load the gem
1391
+ require 'purecloud'
1392
+ # setup authorization
1393
+ @secret = ENV['PURECLOUD_SECRET']
1394
+ @id = ENV['PURECLOUD_CLIENT_ID']
1395
+ environment = "mypurecloud.com"
1396
+
1397
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1398
+
1399
+ PureCloud.configure do |config|
1400
+ config.access_token = @authToken
1401
+ end
1402
+
1403
+ api_instance = PureCloud::RoutingApi.new
1404
+
1405
+ code_id = "code_id_example" # String | Wrapup Code ID
1406
+
1407
+
1408
+ begin
1409
+ #Get details about this wrap-up code.
1410
+ result = api_instance.get_wrapupcodes_code_id(code_id)
1411
+ p result
1412
+ rescue PureCloud::ApiError => e
1413
+ puts "Exception when calling RoutingApi->get_wrapupcodes_code_id: #{e}"
1414
+ end
1415
+ ~~~
1416
+
1417
+ ### Parameters
1418
+
1419
+ Name | Type | Description | Notes
1420
+ ------------- | ------------- | ------------- | -------------
1421
+ **code_id** | **String**| Wrapup Code ID |
1422
+ {: class="table table-striped"}
1423
+
1424
+
1425
+ ### Return type
1426
+
1427
+ [**WrapupCode**](WrapupCode.html)
1428
+
1429
+ ### HTTP request headers
1430
+
1431
+ - **Content-Type**: application/json
1432
+ - **Accept**: application/json
1433
+
1434
+
1435
+
1436
+ <a name="patch_queues_queue_id_users"></a>
1437
+
1438
+ ## -[**QueueMember**](QueueMember.html) patch_queues_queue_id_users(queue_id, opts)
1439
+
1440
+ Join or unjoin a set of users for a queue
1441
+
1442
+
1443
+
1444
+ ### Example
1445
+ ~~~ruby
1446
+ # load the gem
1447
+ require 'purecloud'
1448
+ # setup authorization
1449
+ @secret = ENV['PURECLOUD_SECRET']
1450
+ @id = ENV['PURECLOUD_CLIENT_ID']
1451
+ environment = "mypurecloud.com"
1452
+
1453
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1454
+
1455
+ PureCloud.configure do |config|
1456
+ config.access_token = @authToken
1457
+ end
1458
+
1459
+ api_instance = PureCloud::RoutingApi.new
1460
+
1461
+ queue_id = "queue_id_example" # String | Queue ID
1462
+
1463
+ opts = {
1464
+ body: [PureCloud::QueueMember.new] # Array<QueueMember> | Queue Members
1465
+ }
1466
+
1467
+ begin
1468
+ #Join or unjoin a set of users for a queue
1469
+ result = api_instance.patch_queues_queue_id_users(queue_id, opts)
1470
+ p result
1471
+ rescue PureCloud::ApiError => e
1472
+ puts "Exception when calling RoutingApi->patch_queues_queue_id_users: #{e}"
1473
+ end
1474
+ ~~~
1475
+
1476
+ ### Parameters
1477
+
1478
+ Name | Type | Description | Notes
1479
+ ------------- | ------------- | ------------- | -------------
1480
+ **queue_id** | **String**| Queue ID |
1481
+ **body** | [**Array&lt;QueueMember&gt;**](QueueMember.html)| Queue Members | [optional]
1482
+ {: class="table table-striped"}
1483
+
1484
+
1485
+ ### Return type
1486
+
1487
+ [**QueueMember**](QueueMember.html)
1488
+
1489
+ ### HTTP request headers
1490
+
1491
+ - **Content-Type**: application/json
1492
+ - **Accept**: application/json
1493
+
1494
+
1495
+
1496
+ <a name="patch_queues_queue_id_users_member_id"></a>
1497
+
1498
+ ## -[**QueueMember**](QueueMember.html) patch_queues_queue_id_users_member_id(queue_id, member_id, opts)
1499
+
1500
+ Update the ring number of joined status for a User in a Queue
1501
+
1502
+
1503
+
1504
+ ### Example
1505
+ ~~~ruby
1506
+ # load the gem
1507
+ require 'purecloud'
1508
+ # setup authorization
1509
+ @secret = ENV['PURECLOUD_SECRET']
1510
+ @id = ENV['PURECLOUD_CLIENT_ID']
1511
+ environment = "mypurecloud.com"
1512
+
1513
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1514
+
1515
+ PureCloud.configure do |config|
1516
+ config.access_token = @authToken
1517
+ end
1518
+
1519
+ api_instance = PureCloud::RoutingApi.new
1520
+
1521
+ queue_id = "queue_id_example" # String | Queue ID
1522
+
1523
+ member_id = "member_id_example" # String | Member ID
1524
+
1525
+ opts = {
1526
+ body: PureCloud::QueueMember.new # QueueMember | Queue Member
1527
+ }
1528
+
1529
+ begin
1530
+ #Update the ring number of joined status for a User in a Queue
1531
+ result = api_instance.patch_queues_queue_id_users_member_id(queue_id, member_id, opts)
1532
+ p result
1533
+ rescue PureCloud::ApiError => e
1534
+ puts "Exception when calling RoutingApi->patch_queues_queue_id_users_member_id: #{e}"
1535
+ end
1536
+ ~~~
1537
+
1538
+ ### Parameters
1539
+
1540
+ Name | Type | Description | Notes
1541
+ ------------- | ------------- | ------------- | -------------
1542
+ **queue_id** | **String**| Queue ID |
1543
+ **member_id** | **String**| Member ID |
1544
+ **body** | [**QueueMember**](QueueMember.html)| Queue Member | [optional]
1545
+ {: class="table table-striped"}
1546
+
1547
+
1548
+ ### Return type
1549
+
1550
+ [**QueueMember**](QueueMember.html)
1551
+
1552
+ ### HTTP request headers
1553
+
1554
+ - **Content-Type**: application/json
1555
+ - **Accept**: application/json
1556
+
1557
+
1558
+
1559
+ <a name="post_email_domains"></a>
1560
+
1561
+ ## -[**InboundDomain**](InboundDomain.html) post_email_domains(opts)
1562
+
1563
+ Create a domain
1564
+
1565
+
1566
+
1567
+ ### Example
1568
+ ~~~ruby
1569
+ # load the gem
1570
+ require 'purecloud'
1571
+ # setup authorization
1572
+ @secret = ENV['PURECLOUD_SECRET']
1573
+ @id = ENV['PURECLOUD_CLIENT_ID']
1574
+ environment = "mypurecloud.com"
1575
+
1576
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1577
+
1578
+ PureCloud.configure do |config|
1579
+ config.access_token = @authToken
1580
+ end
1581
+
1582
+ api_instance = PureCloud::RoutingApi.new
1583
+
1584
+ opts = {
1585
+ body: PureCloud::InboundDomain.new # InboundDomain | Domain
1586
+ }
1587
+
1588
+ begin
1589
+ #Create a domain
1590
+ result = api_instance.post_email_domains(opts)
1591
+ p result
1592
+ rescue PureCloud::ApiError => e
1593
+ puts "Exception when calling RoutingApi->post_email_domains: #{e}"
1594
+ end
1595
+ ~~~
1596
+
1597
+ ### Parameters
1598
+
1599
+ Name | Type | Description | Notes
1600
+ ------------- | ------------- | ------------- | -------------
1601
+ **body** | [**InboundDomain**](InboundDomain.html)| Domain | [optional]
1602
+ {: class="table table-striped"}
1603
+
1604
+
1605
+ ### Return type
1606
+
1607
+ [**InboundDomain**](InboundDomain.html)
1608
+
1609
+ ### HTTP request headers
1610
+
1611
+ - **Content-Type**: application/json
1612
+ - **Accept**: application/json
1613
+
1614
+
1615
+
1616
+ <a name="post_email_domains_domain_routes"></a>
1617
+
1618
+ ## -[**InboundRoute**](InboundRoute.html) post_email_domains_domain_routes(domain, opts)
1619
+
1620
+ Create a route
1621
+
1622
+
1623
+
1624
+ ### Example
1625
+ ~~~ruby
1626
+ # load the gem
1627
+ require 'purecloud'
1628
+ # setup authorization
1629
+ @secret = ENV['PURECLOUD_SECRET']
1630
+ @id = ENV['PURECLOUD_CLIENT_ID']
1631
+ environment = "mypurecloud.com"
1632
+
1633
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1634
+
1635
+ PureCloud.configure do |config|
1636
+ config.access_token = @authToken
1637
+ end
1638
+
1639
+ api_instance = PureCloud::RoutingApi.new
1640
+
1641
+ domain = "domain_example" # String | email domain
1642
+
1643
+ opts = {
1644
+ body: PureCloud::InboundRoute.new # InboundRoute | Route
1645
+ }
1646
+
1647
+ begin
1648
+ #Create a route
1649
+ result = api_instance.post_email_domains_domain_routes(domain, opts)
1650
+ p result
1651
+ rescue PureCloud::ApiError => e
1652
+ puts "Exception when calling RoutingApi->post_email_domains_domain_routes: #{e}"
1653
+ end
1654
+ ~~~
1655
+
1656
+ ### Parameters
1657
+
1658
+ Name | Type | Description | Notes
1659
+ ------------- | ------------- | ------------- | -------------
1660
+ **domain** | **String**| email domain |
1661
+ **body** | [**InboundRoute**](InboundRoute.html)| Route | [optional]
1662
+ {: class="table table-striped"}
1663
+
1664
+
1665
+ ### Return type
1666
+
1667
+ [**InboundRoute**](InboundRoute.html)
1668
+
1669
+ ### HTTP request headers
1670
+
1671
+ - **Content-Type**: application/json
1672
+ - **Accept**: application/json
1673
+
1674
+
1675
+
1676
+ <a name="post_queues"></a>
1677
+
1678
+ ## -[**Queue**](Queue.html) post_queues(opts)
1679
+
1680
+ Create queue
1681
+
1682
+
1683
+
1684
+ ### Example
1685
+ ~~~ruby
1686
+ # load the gem
1687
+ require 'purecloud'
1688
+ # setup authorization
1689
+ @secret = ENV['PURECLOUD_SECRET']
1690
+ @id = ENV['PURECLOUD_CLIENT_ID']
1691
+ environment = "mypurecloud.com"
1692
+
1693
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1694
+
1695
+ PureCloud.configure do |config|
1696
+ config.access_token = @authToken
1697
+ end
1698
+
1699
+ api_instance = PureCloud::RoutingApi.new
1700
+
1701
+ opts = {
1702
+ body: PureCloud::Queue.new # Queue | Queue
1703
+ }
1704
+
1705
+ begin
1706
+ #Create queue
1707
+ result = api_instance.post_queues(opts)
1708
+ p result
1709
+ rescue PureCloud::ApiError => e
1710
+ puts "Exception when calling RoutingApi->post_queues: #{e}"
1711
+ end
1712
+ ~~~
1713
+
1714
+ ### Parameters
1715
+
1716
+ Name | Type | Description | Notes
1717
+ ------------- | ------------- | ------------- | -------------
1718
+ **body** | [**Queue**](Queue.html)| Queue | [optional]
1719
+ {: class="table table-striped"}
1720
+
1721
+
1722
+ ### Return type
1723
+
1724
+ [**Queue**](Queue.html)
1725
+
1726
+ ### HTTP request headers
1727
+
1728
+ - **Content-Type**: application/json
1729
+ - **Accept**: application/json
1730
+
1731
+
1732
+
1733
+ <a name="post_queues_observations_query"></a>
1734
+
1735
+ ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(opts)
1736
+
1737
+ Query for queue observations
1738
+
1739
+
1740
+
1741
+ ### Example
1742
+ ~~~ruby
1743
+ # load the gem
1744
+ require 'purecloud'
1745
+ # setup authorization
1746
+ @secret = ENV['PURECLOUD_SECRET']
1747
+ @id = ENV['PURECLOUD_CLIENT_ID']
1748
+ environment = "mypurecloud.com"
1749
+
1750
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1751
+
1752
+ PureCloud.configure do |config|
1753
+ config.access_token = @authToken
1754
+ end
1755
+
1756
+ api_instance = PureCloud::RoutingApi.new
1757
+
1758
+ opts = {
1759
+ body: PureCloud::ObservationQuery.new # ObservationQuery | query
1760
+ }
1761
+
1762
+ begin
1763
+ #Query for queue observations
1764
+ result = api_instance.post_queues_observations_query(opts)
1765
+ p result
1766
+ rescue PureCloud::ApiError => e
1767
+ puts "Exception when calling RoutingApi->post_queues_observations_query: #{e}"
1768
+ end
1769
+ ~~~
1770
+
1771
+ ### Parameters
1772
+
1773
+ Name | Type | Description | Notes
1774
+ ------------- | ------------- | ------------- | -------------
1775
+ **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional]
1776
+ {: class="table table-striped"}
1777
+
1778
+
1779
+ ### Return type
1780
+
1781
+ [**ObservationQueryResponse**](ObservationQueryResponse.html)
1782
+
1783
+ ### HTTP request headers
1784
+
1785
+ - **Content-Type**: application/json
1786
+ - **Accept**: application/json
1787
+
1788
+
1789
+
1790
+ <a name="post_queues_queue_id_users"></a>
1791
+
1792
+ ## -[**QueueMember**](QueueMember.html) post_queues_queue_id_users(queue_id, opts)
1793
+
1794
+ Bulk add or delete up to 100 queue members
1795
+
1796
+
1797
+
1798
+ ### Example
1799
+ ~~~ruby
1800
+ # load the gem
1801
+ require 'purecloud'
1802
+ # setup authorization
1803
+ @secret = ENV['PURECLOUD_SECRET']
1804
+ @id = ENV['PURECLOUD_CLIENT_ID']
1805
+ environment = "mypurecloud.com"
1806
+
1807
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1808
+
1809
+ PureCloud.configure do |config|
1810
+ config.access_token = @authToken
1811
+ end
1812
+
1813
+ api_instance = PureCloud::RoutingApi.new
1814
+
1815
+ queue_id = "queue_id_example" # String | Queue ID
1816
+
1817
+ opts = {
1818
+ body: [PureCloud::QueueMember.new], # Array<QueueMember> | Queue Members
1819
+ delete: false # BOOLEAN | True to delete queue members
1820
+ }
1821
+
1822
+ begin
1823
+ #Bulk add or delete up to 100 queue members
1824
+ result = api_instance.post_queues_queue_id_users(queue_id, opts)
1825
+ p result
1826
+ rescue PureCloud::ApiError => e
1827
+ puts "Exception when calling RoutingApi->post_queues_queue_id_users: #{e}"
1828
+ end
1829
+ ~~~
1830
+
1831
+ ### Parameters
1832
+
1833
+ Name | Type | Description | Notes
1834
+ ------------- | ------------- | ------------- | -------------
1835
+ **queue_id** | **String**| Queue ID |
1836
+ **body** | [**Array&lt;QueueMember&gt;**](QueueMember.html)| Queue Members | [optional]
1837
+ **delete** | **BOOLEAN**| True to delete queue members | [optional] [default to false]
1838
+ {: class="table table-striped"}
1839
+
1840
+
1841
+ ### Return type
1842
+
1843
+ [**QueueMember**](QueueMember.html)
1844
+
1845
+ ### HTTP request headers
1846
+
1847
+ - **Content-Type**: application/json
1848
+ - **Accept**: application/json
1849
+
1850
+
1851
+
1852
+ <a name="post_queues_queue_id_wrapupcodes"></a>
1853
+
1854
+ ## -[**WrapupCode**](WrapupCode.html) post_queues_queue_id_wrapupcodes(queue_id, code_id, opts)
1855
+
1856
+ Add up to 100 wrap-up codes to a queue
1857
+
1858
+
1859
+
1860
+ ### Example
1861
+ ~~~ruby
1862
+ # load the gem
1863
+ require 'purecloud'
1864
+ # setup authorization
1865
+ @secret = ENV['PURECLOUD_SECRET']
1866
+ @id = ENV['PURECLOUD_CLIENT_ID']
1867
+ environment = "mypurecloud.com"
1868
+
1869
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1870
+
1871
+ PureCloud.configure do |config|
1872
+ config.access_token = @authToken
1873
+ end
1874
+
1875
+ api_instance = PureCloud::RoutingApi.new
1876
+
1877
+ queue_id = "queue_id_example" # String | Queue ID
1878
+
1879
+ code_id = "code_id_example" # String | Code ID
1880
+
1881
+ opts = {
1882
+ body: [PureCloud::WrapupCode.new] # Array<WrapupCode> |
1883
+ }
1884
+
1885
+ begin
1886
+ #Add up to 100 wrap-up codes to a queue
1887
+ result = api_instance.post_queues_queue_id_wrapupcodes(queue_id, code_id, opts)
1888
+ p result
1889
+ rescue PureCloud::ApiError => e
1890
+ puts "Exception when calling RoutingApi->post_queues_queue_id_wrapupcodes: #{e}"
1891
+ end
1892
+ ~~~
1893
+
1894
+ ### Parameters
1895
+
1896
+ Name | Type | Description | Notes
1897
+ ------------- | ------------- | ------------- | -------------
1898
+ **queue_id** | **String**| Queue ID |
1899
+ **code_id** | **String**| Code ID |
1900
+ **body** | [**Array&lt;WrapupCode&gt;**](WrapupCode.html)| | [optional]
1901
+ {: class="table table-striped"}
1902
+
1903
+
1904
+ ### Return type
1905
+
1906
+ [**WrapupCode**](WrapupCode.html)
1907
+
1908
+ ### HTTP request headers
1909
+
1910
+ - **Content-Type**: application/json
1911
+ - **Accept**: application/json
1912
+
1913
+
1914
+
1915
+ <a name="post_skills"></a>
1916
+
1917
+ ## -[**RoutingSkill**](RoutingSkill.html) post_skills(opts)
1918
+
1919
+ Create Skill
1920
+
1921
+
1922
+
1923
+ ### Example
1924
+ ~~~ruby
1925
+ # load the gem
1926
+ require 'purecloud'
1927
+ # setup authorization
1928
+ @secret = ENV['PURECLOUD_SECRET']
1929
+ @id = ENV['PURECLOUD_CLIENT_ID']
1930
+ environment = "mypurecloud.com"
1931
+
1932
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1933
+
1934
+ PureCloud.configure do |config|
1935
+ config.access_token = @authToken
1936
+ end
1937
+
1938
+ api_instance = PureCloud::RoutingApi.new
1939
+
1940
+ opts = {
1941
+ body: PureCloud::RoutingSkill.new # RoutingSkill | Skill
1942
+ }
1943
+
1944
+ begin
1945
+ #Create Skill
1946
+ result = api_instance.post_skills(opts)
1947
+ p result
1948
+ rescue PureCloud::ApiError => e
1949
+ puts "Exception when calling RoutingApi->post_skills: #{e}"
1950
+ end
1951
+ ~~~
1952
+
1953
+ ### Parameters
1954
+
1955
+ Name | Type | Description | Notes
1956
+ ------------- | ------------- | ------------- | -------------
1957
+ **body** | [**RoutingSkill**](RoutingSkill.html)| Skill | [optional]
1958
+ {: class="table table-striped"}
1959
+
1960
+
1961
+ ### Return type
1962
+
1963
+ [**RoutingSkill**](RoutingSkill.html)
1964
+
1965
+ ### HTTP request headers
1966
+
1967
+ - **Content-Type**: application/json
1968
+ - **Accept**: application/json
1969
+
1970
+
1971
+
1972
+ <a name="post_user_id_routingskills"></a>
1973
+
1974
+ ## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_id_routingskills(user_id, opts)
1975
+
1976
+ Add routing skill to user
1977
+
1978
+
1979
+
1980
+ ### Example
1981
+ ~~~ruby
1982
+ # load the gem
1983
+ require 'purecloud'
1984
+ # setup authorization
1985
+ @secret = ENV['PURECLOUD_SECRET']
1986
+ @id = ENV['PURECLOUD_CLIENT_ID']
1987
+ environment = "mypurecloud.com"
1988
+
1989
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1990
+
1991
+ PureCloud.configure do |config|
1992
+ config.access_token = @authToken
1993
+ end
1994
+
1995
+ api_instance = PureCloud::RoutingApi.new
1996
+
1997
+ user_id = "user_id_example" # String | User ID
1998
+
1999
+ opts = {
2000
+ body: PureCloud::UserRoutingSkill.new # UserRoutingSkill | Skill
2001
+ }
2002
+
2003
+ begin
2004
+ #Add routing skill to user
2005
+ result = api_instance.post_user_id_routingskills(user_id, opts)
2006
+ p result
2007
+ rescue PureCloud::ApiError => e
2008
+ puts "Exception when calling RoutingApi->post_user_id_routingskills: #{e}"
2009
+ end
2010
+ ~~~
2011
+
2012
+ ### Parameters
2013
+
2014
+ Name | Type | Description | Notes
2015
+ ------------- | ------------- | ------------- | -------------
2016
+ **user_id** | **String**| User ID |
2017
+ **body** | [**UserRoutingSkill**](UserRoutingSkill.html)| Skill | [optional]
2018
+ {: class="table table-striped"}
2019
+
2020
+
2021
+ ### Return type
2022
+
2023
+ [**UserRoutingSkill**](UserRoutingSkill.html)
2024
+
2025
+ ### HTTP request headers
2026
+
2027
+ - **Content-Type**: application/json
2028
+ - **Accept**: application/json
2029
+
2030
+
2031
+
2032
+ <a name="post_wrapupcodes"></a>
2033
+
2034
+ ## -[**CallableTimeSet**](CallableTimeSet.html) post_wrapupcodes(opts)
2035
+
2036
+ Create a wrap-up code
2037
+
2038
+
2039
+
2040
+ ### Example
2041
+ ~~~ruby
2042
+ # load the gem
2043
+ require 'purecloud'
2044
+ # setup authorization
2045
+ @secret = ENV['PURECLOUD_SECRET']
2046
+ @id = ENV['PURECLOUD_CLIENT_ID']
2047
+ environment = "mypurecloud.com"
2048
+
2049
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2050
+
2051
+ PureCloud.configure do |config|
2052
+ config.access_token = @authToken
2053
+ end
2054
+
2055
+ api_instance = PureCloud::RoutingApi.new
2056
+
2057
+ opts = {
2058
+ body: PureCloud::WrapupCode.new # WrapupCode | WrapupCode
2059
+ }
2060
+
2061
+ begin
2062
+ #Create a wrap-up code
2063
+ result = api_instance.post_wrapupcodes(opts)
2064
+ p result
2065
+ rescue PureCloud::ApiError => e
2066
+ puts "Exception when calling RoutingApi->post_wrapupcodes: #{e}"
2067
+ end
2068
+ ~~~
2069
+
2070
+ ### Parameters
2071
+
2072
+ Name | Type | Description | Notes
2073
+ ------------- | ------------- | ------------- | -------------
2074
+ **body** | [**WrapupCode**](WrapupCode.html)| WrapupCode | [optional]
2075
+ {: class="table table-striped"}
2076
+
2077
+
2078
+ ### Return type
2079
+
2080
+ [**CallableTimeSet**](CallableTimeSet.html)
2081
+
2082
+ ### HTTP request headers
2083
+
2084
+ - **Content-Type**: application/json
2085
+ - **Accept**: application/json
2086
+
2087
+
2088
+
2089
+ <a name="put_email_domains_domain_routes_id"></a>
2090
+
2091
+ ## -[**InboundRoute**](InboundRoute.html) put_email_domains_domain_routes_id(domain, id, opts)
2092
+
2093
+ Update a route
2094
+
2095
+
2096
+
2097
+ ### Example
2098
+ ~~~ruby
2099
+ # load the gem
2100
+ require 'purecloud'
2101
+ # setup authorization
2102
+ @secret = ENV['PURECLOUD_SECRET']
2103
+ @id = ENV['PURECLOUD_CLIENT_ID']
2104
+ environment = "mypurecloud.com"
2105
+
2106
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2107
+
2108
+ PureCloud.configure do |config|
2109
+ config.access_token = @authToken
2110
+ end
2111
+
2112
+ api_instance = PureCloud::RoutingApi.new
2113
+
2114
+ domain = "domain_example" # String | email domain
2115
+
2116
+ id = "id_example" # String | route ID
2117
+
2118
+ opts = {
2119
+ body: PureCloud::InboundRoute.new # InboundRoute | Route
2120
+ }
2121
+
2122
+ begin
2123
+ #Update a route
2124
+ result = api_instance.put_email_domains_domain_routes_id(domain, id, opts)
2125
+ p result
2126
+ rescue PureCloud::ApiError => e
2127
+ puts "Exception when calling RoutingApi->put_email_domains_domain_routes_id: #{e}"
2128
+ end
2129
+ ~~~
2130
+
2131
+ ### Parameters
2132
+
2133
+ Name | Type | Description | Notes
2134
+ ------------- | ------------- | ------------- | -------------
2135
+ **domain** | **String**| email domain |
2136
+ **id** | **String**| route ID |
2137
+ **body** | [**InboundRoute**](InboundRoute.html)| Route | [optional]
2138
+ {: class="table table-striped"}
2139
+
2140
+
2141
+ ### Return type
2142
+
2143
+ [**InboundRoute**](InboundRoute.html)
2144
+
2145
+ ### HTTP request headers
2146
+
2147
+ - **Content-Type**: application/json
2148
+ - **Accept**: application/json
2149
+
2150
+
2151
+
2152
+ <a name="put_queues_queue_id"></a>
2153
+
2154
+ ## -[**Queue**](Queue.html) put_queues_queue_id(queue_id, opts)
2155
+
2156
+ Update a queue
2157
+
2158
+
2159
+
2160
+ ### Example
2161
+ ~~~ruby
2162
+ # load the gem
2163
+ require 'purecloud'
2164
+ # setup authorization
2165
+ @secret = ENV['PURECLOUD_SECRET']
2166
+ @id = ENV['PURECLOUD_CLIENT_ID']
2167
+ environment = "mypurecloud.com"
2168
+
2169
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2170
+
2171
+ PureCloud.configure do |config|
2172
+ config.access_token = @authToken
2173
+ end
2174
+
2175
+ api_instance = PureCloud::RoutingApi.new
2176
+
2177
+ queue_id = "queue_id_example" # String | Queue ID
2178
+
2179
+ opts = {
2180
+ body: PureCloud::Queue.new # Queue | Queue
2181
+ }
2182
+
2183
+ begin
2184
+ #Update a queue
2185
+ result = api_instance.put_queues_queue_id(queue_id, opts)
2186
+ p result
2187
+ rescue PureCloud::ApiError => e
2188
+ puts "Exception when calling RoutingApi->put_queues_queue_id: #{e}"
2189
+ end
2190
+ ~~~
2191
+
2192
+ ### Parameters
2193
+
2194
+ Name | Type | Description | Notes
2195
+ ------------- | ------------- | ------------- | -------------
2196
+ **queue_id** | **String**| Queue ID |
2197
+ **body** | [**Queue**](Queue.html)| Queue | [optional]
2198
+ {: class="table table-striped"}
2199
+
2200
+
2201
+ ### Return type
2202
+
2203
+ [**Queue**](Queue.html)
2204
+
2205
+ ### HTTP request headers
2206
+
2207
+ - **Content-Type**: application/json
2208
+ - **Accept**: application/json
2209
+
2210
+
2211
+
2212
+ <a name="put_skills_skill_id"></a>
2213
+
2214
+ ## -[**RoutingSkill**](RoutingSkill.html) put_skills_skill_id(skill_id, opts)
2215
+
2216
+ Update Routing Skill
2217
+
2218
+
2219
+
2220
+ ### Example
2221
+ ~~~ruby
2222
+ # load the gem
2223
+ require 'purecloud'
2224
+ # setup authorization
2225
+ @secret = ENV['PURECLOUD_SECRET']
2226
+ @id = ENV['PURECLOUD_CLIENT_ID']
2227
+ environment = "mypurecloud.com"
2228
+
2229
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2230
+
2231
+ PureCloud.configure do |config|
2232
+ config.access_token = @authToken
2233
+ end
2234
+
2235
+ api_instance = PureCloud::RoutingApi.new
2236
+
2237
+ skill_id = "skill_id_example" # String | Skill ID
2238
+
2239
+ opts = {
2240
+ body: PureCloud::RoutingSkill.new # RoutingSkill | Skill
2241
+ }
2242
+
2243
+ begin
2244
+ #Update Routing Skill
2245
+ result = api_instance.put_skills_skill_id(skill_id, opts)
2246
+ p result
2247
+ rescue PureCloud::ApiError => e
2248
+ puts "Exception when calling RoutingApi->put_skills_skill_id: #{e}"
2249
+ end
2250
+ ~~~
2251
+
2252
+ ### Parameters
2253
+
2254
+ Name | Type | Description | Notes
2255
+ ------------- | ------------- | ------------- | -------------
2256
+ **skill_id** | **String**| Skill ID |
2257
+ **body** | [**RoutingSkill**](RoutingSkill.html)| Skill | [optional]
2258
+ {: class="table table-striped"}
2259
+
2260
+
2261
+ ### Return type
2262
+
2263
+ [**RoutingSkill**](RoutingSkill.html)
2264
+
2265
+ ### HTTP request headers
2266
+
2267
+ - **Content-Type**: application/json
2268
+ - **Accept**: application/json
2269
+
2270
+
2271
+
2272
+ <a name="put_utilization"></a>
2273
+
2274
+ ## -[**Utilization**](Utilization.html) put_utilization(opts)
2275
+
2276
+ Update the utilization settings.
2277
+
2278
+
2279
+
2280
+ ### Example
2281
+ ~~~ruby
2282
+ # load the gem
2283
+ require 'purecloud'
2284
+ # setup authorization
2285
+ @secret = ENV['PURECLOUD_SECRET']
2286
+ @id = ENV['PURECLOUD_CLIENT_ID']
2287
+ environment = "mypurecloud.com"
2288
+
2289
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2290
+
2291
+ PureCloud.configure do |config|
2292
+ config.access_token = @authToken
2293
+ end
2294
+
2295
+ api_instance = PureCloud::RoutingApi.new
2296
+
2297
+ opts = {
2298
+ body: PureCloud::Utilization.new # Utilization | utilization
2299
+ }
2300
+
2301
+ begin
2302
+ #Update the utilization settings.
2303
+ result = api_instance.put_utilization(opts)
2304
+ p result
2305
+ rescue PureCloud::ApiError => e
2306
+ puts "Exception when calling RoutingApi->put_utilization: #{e}"
2307
+ end
2308
+ ~~~
2309
+
2310
+ ### Parameters
2311
+
2312
+ Name | Type | Description | Notes
2313
+ ------------- | ------------- | ------------- | -------------
2314
+ **body** | [**Utilization**](Utilization.html)| utilization | [optional]
2315
+ {: class="table table-striped"}
2316
+
2317
+
2318
+ ### Return type
2319
+
2320
+ [**Utilization**](Utilization.html)
2321
+
2322
+ ### HTTP request headers
2323
+
2324
+ - **Content-Type**: application/json
2325
+ - **Accept**: application/json
2326
+
2327
+
2328
+
2329
+ <a name="put_wrapupcodes_code_id"></a>
2330
+
2331
+ ## -[**WrapupCode**](WrapupCode.html) put_wrapupcodes_code_id(code_id, opts)
2332
+
2333
+ Update wrap-up code
2334
+
2335
+
2336
+
2337
+ ### Example
2338
+ ~~~ruby
2339
+ # load the gem
2340
+ require 'purecloud'
2341
+ # setup authorization
2342
+ @secret = ENV['PURECLOUD_SECRET']
2343
+ @id = ENV['PURECLOUD_CLIENT_ID']
2344
+ environment = "mypurecloud.com"
2345
+
2346
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2347
+
2348
+ PureCloud.configure do |config|
2349
+ config.access_token = @authToken
2350
+ end
2351
+
2352
+ api_instance = PureCloud::RoutingApi.new
2353
+
2354
+ code_id = "code_id_example" # String | Wrapup Code ID
2355
+
2356
+ opts = {
2357
+ body: PureCloud::WrapupCode.new # WrapupCode | WrapupCode
2358
+ }
2359
+
2360
+ begin
2361
+ #Update wrap-up code
2362
+ result = api_instance.put_wrapupcodes_code_id(code_id, opts)
2363
+ p result
2364
+ rescue PureCloud::ApiError => e
2365
+ puts "Exception when calling RoutingApi->put_wrapupcodes_code_id: #{e}"
2366
+ end
2367
+ ~~~
2368
+
2369
+ ### Parameters
2370
+
2371
+ Name | Type | Description | Notes
2372
+ ------------- | ------------- | ------------- | -------------
2373
+ **code_id** | **String**| Wrapup Code ID |
2374
+ **body** | [**WrapupCode**](WrapupCode.html)| WrapupCode | [optional]
2375
+ {: class="table table-striped"}
2376
+
2377
+
2378
+ ### Return type
2379
+
2380
+ [**WrapupCode**](WrapupCode.html)
2381
+
2382
+ ### HTTP request headers
2383
+
2384
+ - **Content-Type**: application/json
2385
+ - **Accept**: application/json
2386
+
2387
+
2388
+