purecloud 0.35.1 → 0.36.1

Sign up to get free protection for your applications and to get access to all the features.
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,1233 @@
1
+ ---
2
+ title: AnalyticsApi
3
+ ---
4
+
5
+ ## PureCloud::AnalyticsApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | HTTP request | Description
10
+ ------------- | ------------- | -------------
11
+ |[**delete_reporting_schedules_schedule_id**](AnalyticsApi.html#delete_reporting_schedules_schedule_id) | **DELETE** /api/v2/analytics/reporting/schedules/{scheduleId} | Delete a scheduled report job.|
12
+ |[**get_conversations_conversation_id_details**](AnalyticsApi.html#get_conversations_conversation_id_details) | **GET** /api/v2/analytics/conversations/{conversationId}/details | Get a conversation by id|
13
+ |[**get_reporting_metadata**](AnalyticsApi.html#get_reporting_metadata) | **GET** /api/v2/analytics/reporting/metadata | Get list of reporting metadata.|
14
+ |[**get_reporting_report_id_metadata**](AnalyticsApi.html#get_reporting_report_id_metadata) | **GET** /api/v2/analytics/reporting/{reportId}/metadata | Get a reporting metadata.|
15
+ |[**get_reporting_reportformats**](AnalyticsApi.html#get_reporting_reportformats) | **GET** /api/v2/analytics/reporting/reportformats | Get a list of report formats|
16
+ |[**get_reporting_schedules**](AnalyticsApi.html#get_reporting_schedules) | **GET** /api/v2/analytics/reporting/schedules | Get a list of scheduled report jobs|
17
+ |[**get_reporting_schedules_schedule_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId} | Get a scheduled report job.|
18
+ |[**get_reporting_schedules_schedule_id_history**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history | Get list of completed scheduled report jobs.|
19
+ |[**get_reporting_schedules_schedule_id_history_latest**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_latest) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest | Get most recently completed scheduled report job.|
20
+ |[**get_reporting_schedules_schedule_id_history_run_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_run_id) | **GET** /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId} | A completed scheduled report job|
21
+ |[**get_reporting_timeperiods**](AnalyticsApi.html#get_reporting_timeperiods) | **GET** /api/v2/analytics/reporting/timeperiods | Get a list of report time periods.|
22
+ |[**post_conversations_aggregates_query**](AnalyticsApi.html#post_conversations_aggregates_query) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates|
23
+ |[**post_conversations_conversation_id_details_properties**](AnalyticsApi.html#post_conversations_conversation_id_details_properties) | **POST** /api/v2/analytics/conversations/{conversationId}/details/properties | Index conversation properties|
24
+ |[**post_conversations_details_query**](AnalyticsApi.html#post_conversations_details_query) | **POST** /api/v2/analytics/conversations/details/query | Query for conversation details|
25
+ |[**post_evaluations_aggregates_query**](AnalyticsApi.html#post_evaluations_aggregates_query) | **POST** /api/v2/analytics/evaluations/aggregates/query | Query for evaluation aggregates|
26
+ |[**post_queues_observations_query**](AnalyticsApi.html#post_queues_observations_query) | **POST** /api/v2/analytics/queues/observations/query | Query for queue observations|
27
+ |[**post_reporting_schedules**](AnalyticsApi.html#post_reporting_schedules) | **POST** /api/v2/analytics/reporting/schedules | Create a scheduled report job|
28
+ |[**post_reporting_schedules_schedule_id_runreport**](AnalyticsApi.html#post_reporting_schedules_schedule_id_runreport) | **POST** /api/v2/analytics/reporting/schedules/{scheduleId}/runreport | Place a scheduled report immediately into the reporting queue|
29
+ |[**post_users_aggregates_query**](AnalyticsApi.html#post_users_aggregates_query) | **POST** /api/v2/analytics/users/aggregates/query | Query for user aggregates|
30
+ |[**post_users_observations_query**](AnalyticsApi.html#post_users_observations_query) | **POST** /api/v2/analytics/users/observations/query | Query for user observations|
31
+ |[**put_reporting_schedules_schedule_id**](AnalyticsApi.html#put_reporting_schedules_schedule_id) | **PUT** /api/v2/analytics/reporting/schedules/{scheduleId} | Update a scheduled report job.|
32
+ {: class="table table-striped"}
33
+
34
+ <a name="delete_reporting_schedules_schedule_id"></a>
35
+
36
+ ## -String** delete_reporting_schedules_schedule_id(schedule_id)
37
+
38
+ Delete a scheduled report job.
39
+
40
+
41
+
42
+ ### Example
43
+ ~~~ruby
44
+ # load the gem
45
+ require 'purecloud'
46
+ # setup authorization
47
+ @secret = ENV['PURECLOUD_SECRET']
48
+ @id = ENV['PURECLOUD_CLIENT_ID']
49
+ environment = "mypurecloud.com"
50
+
51
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
52
+
53
+ PureCloud.configure do |config|
54
+ config.access_token = @authToken
55
+ end
56
+
57
+ api_instance = PureCloud::AnalyticsApi.new
58
+
59
+ schedule_id = "schedule_id_example" # String | Schedule ID
60
+
61
+
62
+ begin
63
+ #Delete a scheduled report job.
64
+ result = api_instance.delete_reporting_schedules_schedule_id(schedule_id)
65
+ p result
66
+ rescue PureCloud::ApiError => e
67
+ puts "Exception when calling AnalyticsApi->delete_reporting_schedules_schedule_id: #{e}"
68
+ end
69
+ ~~~
70
+
71
+ ### Parameters
72
+
73
+ Name | Type | Description | Notes
74
+ ------------- | ------------- | ------------- | -------------
75
+ **schedule_id** | **String**| Schedule ID |
76
+ {: class="table table-striped"}
77
+
78
+
79
+ ### Return type
80
+
81
+ **String**
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: application/json
86
+ - **Accept**: application/json
87
+
88
+
89
+
90
+ <a name="get_conversations_conversation_id_details"></a>
91
+
92
+ ## -[**AnalyticsConversation**](AnalyticsConversation.html) get_conversations_conversation_id_details(conversation_id)
93
+
94
+ Get a conversation by id
95
+
96
+
97
+
98
+ ### Example
99
+ ~~~ruby
100
+ # load the gem
101
+ require 'purecloud'
102
+ # setup authorization
103
+ @secret = ENV['PURECLOUD_SECRET']
104
+ @id = ENV['PURECLOUD_CLIENT_ID']
105
+ environment = "mypurecloud.com"
106
+
107
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
108
+
109
+ PureCloud.configure do |config|
110
+ config.access_token = @authToken
111
+ end
112
+
113
+ api_instance = PureCloud::AnalyticsApi.new
114
+
115
+ conversation_id = "conversation_id_example" # String | conversationId
116
+
117
+
118
+ begin
119
+ #Get a conversation by id
120
+ result = api_instance.get_conversations_conversation_id_details(conversation_id)
121
+ p result
122
+ rescue PureCloud::ApiError => e
123
+ puts "Exception when calling AnalyticsApi->get_conversations_conversation_id_details: #{e}"
124
+ end
125
+ ~~~
126
+
127
+ ### Parameters
128
+
129
+ Name | Type | Description | Notes
130
+ ------------- | ------------- | ------------- | -------------
131
+ **conversation_id** | **String**| conversationId |
132
+ {: class="table table-striped"}
133
+
134
+
135
+ ### Return type
136
+
137
+ [**AnalyticsConversation**](AnalyticsConversation.html)
138
+
139
+ ### HTTP request headers
140
+
141
+ - **Content-Type**: application/json
142
+ - **Accept**: application/json
143
+
144
+
145
+
146
+ <a name="get_reporting_metadata"></a>
147
+
148
+ ## -[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_reporting_metadata(opts)
149
+
150
+ Get list of reporting metadata.
151
+
152
+
153
+
154
+ ### Example
155
+ ~~~ruby
156
+ # load the gem
157
+ require 'purecloud'
158
+ # setup authorization
159
+ @secret = ENV['PURECLOUD_SECRET']
160
+ @id = ENV['PURECLOUD_CLIENT_ID']
161
+ environment = "mypurecloud.com"
162
+
163
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
164
+
165
+ PureCloud.configure do |config|
166
+ config.access_token = @authToken
167
+ end
168
+
169
+ api_instance = PureCloud::AnalyticsApi.new
170
+
171
+ opts = {
172
+ page_number: 1, # Integer | Page number
173
+ page_size: 25, # Integer | Page size
174
+ locale: "locale_example" # String | Locale
175
+ }
176
+
177
+ begin
178
+ #Get list of reporting metadata.
179
+ result = api_instance.get_reporting_metadata(opts)
180
+ p result
181
+ rescue PureCloud::ApiError => e
182
+ puts "Exception when calling AnalyticsApi->get_reporting_metadata: #{e}"
183
+ end
184
+ ~~~
185
+
186
+ ### Parameters
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
191
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
192
+ **locale** | **String**| Locale | [optional]
193
+ {: class="table table-striped"}
194
+
195
+
196
+ ### Return type
197
+
198
+ [**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: application/json
203
+ - **Accept**: application/json
204
+
205
+
206
+
207
+ <a name="get_reporting_report_id_metadata"></a>
208
+
209
+ ## -[**ReportMetaData**](ReportMetaData.html) get_reporting_report_id_metadata(report_id, opts)
210
+
211
+ Get a reporting metadata.
212
+
213
+
214
+
215
+ ### Example
216
+ ~~~ruby
217
+ # load the gem
218
+ require 'purecloud'
219
+ # setup authorization
220
+ @secret = ENV['PURECLOUD_SECRET']
221
+ @id = ENV['PURECLOUD_CLIENT_ID']
222
+ environment = "mypurecloud.com"
223
+
224
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
225
+
226
+ PureCloud.configure do |config|
227
+ config.access_token = @authToken
228
+ end
229
+
230
+ api_instance = PureCloud::AnalyticsApi.new
231
+
232
+ report_id = "report_id_example" # String | Report ID
233
+
234
+ opts = {
235
+ locale: "locale_example" # String | Locale
236
+ }
237
+
238
+ begin
239
+ #Get a reporting metadata.
240
+ result = api_instance.get_reporting_report_id_metadata(report_id, opts)
241
+ p result
242
+ rescue PureCloud::ApiError => e
243
+ puts "Exception when calling AnalyticsApi->get_reporting_report_id_metadata: #{e}"
244
+ end
245
+ ~~~
246
+
247
+ ### Parameters
248
+
249
+ Name | Type | Description | Notes
250
+ ------------- | ------------- | ------------- | -------------
251
+ **report_id** | **String**| Report ID |
252
+ **locale** | **String**| Locale | [optional]
253
+ {: class="table table-striped"}
254
+
255
+
256
+ ### Return type
257
+
258
+ [**ReportMetaData**](ReportMetaData.html)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+
267
+ <a name="get_reporting_reportformats"></a>
268
+
269
+ ## -Array&lt;String&gt;** get_reporting_reportformats
270
+
271
+ Get a list of report formats
272
+
273
+ Get a list of report formats.
274
+
275
+ ### Example
276
+ ~~~ruby
277
+ # load the gem
278
+ require 'purecloud'
279
+ # setup authorization
280
+ @secret = ENV['PURECLOUD_SECRET']
281
+ @id = ENV['PURECLOUD_CLIENT_ID']
282
+ environment = "mypurecloud.com"
283
+
284
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
285
+
286
+ PureCloud.configure do |config|
287
+ config.access_token = @authToken
288
+ end
289
+
290
+ api_instance = PureCloud::AnalyticsApi.new
291
+
292
+ begin
293
+ #Get a list of report formats
294
+ result = api_instance.get_reporting_reportformats
295
+ p result
296
+ rescue PureCloud::ApiError => e
297
+ puts "Exception when calling AnalyticsApi->get_reporting_reportformats: #{e}"
298
+ end
299
+ ~~~
300
+
301
+ ### Parameters
302
+ This endpoint does not need any parameter.
303
+ {: class="table table-striped"}
304
+
305
+
306
+ ### Return type
307
+
308
+ **Array&lt;String&gt;**
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: application/json
313
+ - **Accept**: application/json
314
+
315
+
316
+
317
+ <a name="get_reporting_schedules"></a>
318
+
319
+ ## -[**ReportScheduleEntityListing**](ReportScheduleEntityListing.html) get_reporting_schedules(opts)
320
+
321
+ Get a list of scheduled report jobs
322
+
323
+ Get a list of scheduled report jobs.
324
+
325
+ ### Example
326
+ ~~~ruby
327
+ # load the gem
328
+ require 'purecloud'
329
+ # setup authorization
330
+ @secret = ENV['PURECLOUD_SECRET']
331
+ @id = ENV['PURECLOUD_CLIENT_ID']
332
+ environment = "mypurecloud.com"
333
+
334
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
335
+
336
+ PureCloud.configure do |config|
337
+ config.access_token = @authToken
338
+ end
339
+
340
+ api_instance = PureCloud::AnalyticsApi.new
341
+
342
+ opts = {
343
+ page_number: 1, # Integer | Page number
344
+ page_size: 25 # Integer | Page size
345
+ }
346
+
347
+ begin
348
+ #Get a list of scheduled report jobs
349
+ result = api_instance.get_reporting_schedules(opts)
350
+ p result
351
+ rescue PureCloud::ApiError => e
352
+ puts "Exception when calling AnalyticsApi->get_reporting_schedules: #{e}"
353
+ end
354
+ ~~~
355
+
356
+ ### Parameters
357
+
358
+ Name | Type | Description | Notes
359
+ ------------- | ------------- | ------------- | -------------
360
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
361
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
362
+ {: class="table table-striped"}
363
+
364
+
365
+ ### Return type
366
+
367
+ [**ReportScheduleEntityListing**](ReportScheduleEntityListing.html)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: application/json
372
+ - **Accept**: application/json
373
+
374
+
375
+
376
+ <a name="get_reporting_schedules_schedule_id"></a>
377
+
378
+ ## -[**ReportSchedule**](ReportSchedule.html) get_reporting_schedules_schedule_id(schedule_id)
379
+
380
+ Get a scheduled report job.
381
+
382
+
383
+
384
+ ### Example
385
+ ~~~ruby
386
+ # load the gem
387
+ require 'purecloud'
388
+ # setup authorization
389
+ @secret = ENV['PURECLOUD_SECRET']
390
+ @id = ENV['PURECLOUD_CLIENT_ID']
391
+ environment = "mypurecloud.com"
392
+
393
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
394
+
395
+ PureCloud.configure do |config|
396
+ config.access_token = @authToken
397
+ end
398
+
399
+ api_instance = PureCloud::AnalyticsApi.new
400
+
401
+ schedule_id = "schedule_id_example" # String | Schedule ID
402
+
403
+
404
+ begin
405
+ #Get a scheduled report job.
406
+ result = api_instance.get_reporting_schedules_schedule_id(schedule_id)
407
+ p result
408
+ rescue PureCloud::ApiError => e
409
+ puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id: #{e}"
410
+ end
411
+ ~~~
412
+
413
+ ### Parameters
414
+
415
+ Name | Type | Description | Notes
416
+ ------------- | ------------- | ------------- | -------------
417
+ **schedule_id** | **String**| Schedule ID |
418
+ {: class="table table-striped"}
419
+
420
+
421
+ ### Return type
422
+
423
+ [**ReportSchedule**](ReportSchedule.html)
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: application/json
428
+ - **Accept**: application/json
429
+
430
+
431
+
432
+ <a name="get_reporting_schedules_schedule_id_history"></a>
433
+
434
+ ## -[**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html) get_reporting_schedules_schedule_id_history(schedule_id, opts)
435
+
436
+ Get list of completed scheduled report jobs.
437
+
438
+
439
+
440
+ ### Example
441
+ ~~~ruby
442
+ # load the gem
443
+ require 'purecloud'
444
+ # setup authorization
445
+ @secret = ENV['PURECLOUD_SECRET']
446
+ @id = ENV['PURECLOUD_CLIENT_ID']
447
+ environment = "mypurecloud.com"
448
+
449
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
450
+
451
+ PureCloud.configure do |config|
452
+ config.access_token = @authToken
453
+ end
454
+
455
+ api_instance = PureCloud::AnalyticsApi.new
456
+
457
+ schedule_id = "schedule_id_example" # String | Schedule ID
458
+
459
+ opts = {
460
+ page_number: 1, # Integer |
461
+ page_size: 25 # Integer |
462
+ }
463
+
464
+ begin
465
+ #Get list of completed scheduled report jobs.
466
+ result = api_instance.get_reporting_schedules_schedule_id_history(schedule_id, opts)
467
+ p result
468
+ rescue PureCloud::ApiError => e
469
+ puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history: #{e}"
470
+ end
471
+ ~~~
472
+
473
+ ### Parameters
474
+
475
+ Name | Type | Description | Notes
476
+ ------------- | ------------- | ------------- | -------------
477
+ **schedule_id** | **String**| Schedule ID |
478
+ **page_number** | **Integer**| | [optional] [default to 1]
479
+ **page_size** | **Integer**| | [optional] [default to 25]
480
+ {: class="table table-striped"}
481
+
482
+
483
+ ### Return type
484
+
485
+ [**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html)
486
+
487
+ ### HTTP request headers
488
+
489
+ - **Content-Type**: application/json
490
+ - **Accept**: application/json
491
+
492
+
493
+
494
+ <a name="get_reporting_schedules_schedule_id_history_latest"></a>
495
+
496
+ ## -[**ReportRunEntry**](ReportRunEntry.html) get_reporting_schedules_schedule_id_history_latest(schedule_id)
497
+
498
+ Get most recently completed scheduled report job.
499
+
500
+
501
+
502
+ ### Example
503
+ ~~~ruby
504
+ # load the gem
505
+ require 'purecloud'
506
+ # setup authorization
507
+ @secret = ENV['PURECLOUD_SECRET']
508
+ @id = ENV['PURECLOUD_CLIENT_ID']
509
+ environment = "mypurecloud.com"
510
+
511
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
512
+
513
+ PureCloud.configure do |config|
514
+ config.access_token = @authToken
515
+ end
516
+
517
+ api_instance = PureCloud::AnalyticsApi.new
518
+
519
+ schedule_id = "schedule_id_example" # String | Schedule ID
520
+
521
+
522
+ begin
523
+ #Get most recently completed scheduled report job.
524
+ result = api_instance.get_reporting_schedules_schedule_id_history_latest(schedule_id)
525
+ p result
526
+ rescue PureCloud::ApiError => e
527
+ puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history_latest: #{e}"
528
+ end
529
+ ~~~
530
+
531
+ ### Parameters
532
+
533
+ Name | Type | Description | Notes
534
+ ------------- | ------------- | ------------- | -------------
535
+ **schedule_id** | **String**| Schedule ID |
536
+ {: class="table table-striped"}
537
+
538
+
539
+ ### Return type
540
+
541
+ [**ReportRunEntry**](ReportRunEntry.html)
542
+
543
+ ### HTTP request headers
544
+
545
+ - **Content-Type**: application/json
546
+ - **Accept**: application/json
547
+
548
+
549
+
550
+ <a name="get_reporting_schedules_schedule_id_history_run_id"></a>
551
+
552
+ ## -[**ReportRunEntry**](ReportRunEntry.html) get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id)
553
+
554
+ A completed scheduled report job
555
+
556
+ A completed scheduled report job.
557
+
558
+ ### Example
559
+ ~~~ruby
560
+ # load the gem
561
+ require 'purecloud'
562
+ # setup authorization
563
+ @secret = ENV['PURECLOUD_SECRET']
564
+ @id = ENV['PURECLOUD_CLIENT_ID']
565
+ environment = "mypurecloud.com"
566
+
567
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
568
+
569
+ PureCloud.configure do |config|
570
+ config.access_token = @authToken
571
+ end
572
+
573
+ api_instance = PureCloud::AnalyticsApi.new
574
+
575
+ run_id = "run_id_example" # String | Run ID
576
+
577
+ schedule_id = "schedule_id_example" # String | Schedule ID
578
+
579
+
580
+ begin
581
+ #A completed scheduled report job
582
+ result = api_instance.get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id)
583
+ p result
584
+ rescue PureCloud::ApiError => e
585
+ puts "Exception when calling AnalyticsApi->get_reporting_schedules_schedule_id_history_run_id: #{e}"
586
+ end
587
+ ~~~
588
+
589
+ ### Parameters
590
+
591
+ Name | Type | Description | Notes
592
+ ------------- | ------------- | ------------- | -------------
593
+ **run_id** | **String**| Run ID |
594
+ **schedule_id** | **String**| Schedule ID |
595
+ {: class="table table-striped"}
596
+
597
+
598
+ ### Return type
599
+
600
+ [**ReportRunEntry**](ReportRunEntry.html)
601
+
602
+ ### HTTP request headers
603
+
604
+ - **Content-Type**: application/json
605
+ - **Accept**: application/json
606
+
607
+
608
+
609
+ <a name="get_reporting_timeperiods"></a>
610
+
611
+ ## -Array&lt;String&gt;** get_reporting_timeperiods
612
+
613
+ Get a list of report time periods.
614
+
615
+
616
+
617
+ ### Example
618
+ ~~~ruby
619
+ # load the gem
620
+ require 'purecloud'
621
+ # setup authorization
622
+ @secret = ENV['PURECLOUD_SECRET']
623
+ @id = ENV['PURECLOUD_CLIENT_ID']
624
+ environment = "mypurecloud.com"
625
+
626
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
627
+
628
+ PureCloud.configure do |config|
629
+ config.access_token = @authToken
630
+ end
631
+
632
+ api_instance = PureCloud::AnalyticsApi.new
633
+
634
+ begin
635
+ #Get a list of report time periods.
636
+ result = api_instance.get_reporting_timeperiods
637
+ p result
638
+ rescue PureCloud::ApiError => e
639
+ puts "Exception when calling AnalyticsApi->get_reporting_timeperiods: #{e}"
640
+ end
641
+ ~~~
642
+
643
+ ### Parameters
644
+ This endpoint does not need any parameter.
645
+ {: class="table table-striped"}
646
+
647
+
648
+ ### Return type
649
+
650
+ **Array&lt;String&gt;**
651
+
652
+ ### HTTP request headers
653
+
654
+ - **Content-Type**: application/json
655
+ - **Accept**: application/json
656
+
657
+
658
+
659
+ <a name="post_conversations_aggregates_query"></a>
660
+
661
+ ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_conversations_aggregates_query(opts)
662
+
663
+ Query for conversation aggregates
664
+
665
+
666
+
667
+ ### Example
668
+ ~~~ruby
669
+ # load the gem
670
+ require 'purecloud'
671
+ # setup authorization
672
+ @secret = ENV['PURECLOUD_SECRET']
673
+ @id = ENV['PURECLOUD_CLIENT_ID']
674
+ environment = "mypurecloud.com"
675
+
676
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
677
+
678
+ PureCloud.configure do |config|
679
+ config.access_token = @authToken
680
+ end
681
+
682
+ api_instance = PureCloud::AnalyticsApi.new
683
+
684
+ opts = {
685
+ body: PureCloud::AggregationQuery.new # AggregationQuery | query
686
+ }
687
+
688
+ begin
689
+ #Query for conversation aggregates
690
+ result = api_instance.post_conversations_aggregates_query(opts)
691
+ p result
692
+ rescue PureCloud::ApiError => e
693
+ puts "Exception when calling AnalyticsApi->post_conversations_aggregates_query: #{e}"
694
+ end
695
+ ~~~
696
+
697
+ ### Parameters
698
+
699
+ Name | Type | Description | Notes
700
+ ------------- | ------------- | ------------- | -------------
701
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional]
702
+ {: class="table table-striped"}
703
+
704
+
705
+ ### Return type
706
+
707
+ [**AggregateQueryResponse**](AggregateQueryResponse.html)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: application/json
712
+ - **Accept**: application/json
713
+
714
+
715
+
716
+ <a name="post_conversations_conversation_id_details_properties"></a>
717
+
718
+ ## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_conversations_conversation_id_details_properties(conversation_id, opts)
719
+
720
+ Index conversation properties
721
+
722
+
723
+
724
+ ### Example
725
+ ~~~ruby
726
+ # load the gem
727
+ require 'purecloud'
728
+ # setup authorization
729
+ @secret = ENV['PURECLOUD_SECRET']
730
+ @id = ENV['PURECLOUD_CLIENT_ID']
731
+ environment = "mypurecloud.com"
732
+
733
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
734
+
735
+ PureCloud.configure do |config|
736
+ config.access_token = @authToken
737
+ end
738
+
739
+ api_instance = PureCloud::AnalyticsApi.new
740
+
741
+ conversation_id = "conversation_id_example" # String | conversationId
742
+
743
+ opts = {
744
+ body: PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request
745
+ }
746
+
747
+ begin
748
+ #Index conversation properties
749
+ result = api_instance.post_conversations_conversation_id_details_properties(conversation_id, opts)
750
+ p result
751
+ rescue PureCloud::ApiError => e
752
+ puts "Exception when calling AnalyticsApi->post_conversations_conversation_id_details_properties: #{e}"
753
+ end
754
+ ~~~
755
+
756
+ ### Parameters
757
+
758
+ Name | Type | Description | Notes
759
+ ------------- | ------------- | ------------- | -------------
760
+ **conversation_id** | **String**| conversationId |
761
+ **body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request | [optional]
762
+ {: class="table table-striped"}
763
+
764
+
765
+ ### Return type
766
+
767
+ [**PropertyIndexRequest**](PropertyIndexRequest.html)
768
+
769
+ ### HTTP request headers
770
+
771
+ - **Content-Type**: application/json
772
+ - **Accept**: application/json
773
+
774
+
775
+
776
+ <a name="post_conversations_details_query"></a>
777
+
778
+ ## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_conversations_details_query(opts)
779
+
780
+ Query for conversation details
781
+
782
+
783
+
784
+ ### Example
785
+ ~~~ruby
786
+ # load the gem
787
+ require 'purecloud'
788
+ # setup authorization
789
+ @secret = ENV['PURECLOUD_SECRET']
790
+ @id = ENV['PURECLOUD_CLIENT_ID']
791
+ environment = "mypurecloud.com"
792
+
793
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
794
+
795
+ PureCloud.configure do |config|
796
+ config.access_token = @authToken
797
+ end
798
+
799
+ api_instance = PureCloud::AnalyticsApi.new
800
+
801
+ opts = {
802
+ body: PureCloud::ConversationQuery.new # ConversationQuery | query
803
+ }
804
+
805
+ begin
806
+ #Query for conversation details
807
+ result = api_instance.post_conversations_details_query(opts)
808
+ p result
809
+ rescue PureCloud::ApiError => e
810
+ puts "Exception when calling AnalyticsApi->post_conversations_details_query: #{e}"
811
+ end
812
+ ~~~
813
+
814
+ ### Parameters
815
+
816
+ Name | Type | Description | Notes
817
+ ------------- | ------------- | ------------- | -------------
818
+ **body** | [**ConversationQuery**](ConversationQuery.html)| query | [optional]
819
+ {: class="table table-striped"}
820
+
821
+
822
+ ### Return type
823
+
824
+ [**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html)
825
+
826
+ ### HTTP request headers
827
+
828
+ - **Content-Type**: application/json
829
+ - **Accept**: application/json
830
+
831
+
832
+
833
+ <a name="post_evaluations_aggregates_query"></a>
834
+
835
+ ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_evaluations_aggregates_query(opts)
836
+
837
+ Query for evaluation aggregates
838
+
839
+
840
+
841
+ ### Example
842
+ ~~~ruby
843
+ # load the gem
844
+ require 'purecloud'
845
+ # setup authorization
846
+ @secret = ENV['PURECLOUD_SECRET']
847
+ @id = ENV['PURECLOUD_CLIENT_ID']
848
+ environment = "mypurecloud.com"
849
+
850
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
851
+
852
+ PureCloud.configure do |config|
853
+ config.access_token = @authToken
854
+ end
855
+
856
+ api_instance = PureCloud::AnalyticsApi.new
857
+
858
+ opts = {
859
+ body: PureCloud::AggregationQuery.new # AggregationQuery | query
860
+ }
861
+
862
+ begin
863
+ #Query for evaluation aggregates
864
+ result = api_instance.post_evaluations_aggregates_query(opts)
865
+ p result
866
+ rescue PureCloud::ApiError => e
867
+ puts "Exception when calling AnalyticsApi->post_evaluations_aggregates_query: #{e}"
868
+ end
869
+ ~~~
870
+
871
+ ### Parameters
872
+
873
+ Name | Type | Description | Notes
874
+ ------------- | ------------- | ------------- | -------------
875
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional]
876
+ {: class="table table-striped"}
877
+
878
+
879
+ ### Return type
880
+
881
+ [**AggregateQueryResponse**](AggregateQueryResponse.html)
882
+
883
+ ### HTTP request headers
884
+
885
+ - **Content-Type**: application/json
886
+ - **Accept**: application/json
887
+
888
+
889
+
890
+ <a name="post_queues_observations_query"></a>
891
+
892
+ ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_queues_observations_query(opts)
893
+
894
+ Query for queue observations
895
+
896
+
897
+
898
+ ### Example
899
+ ~~~ruby
900
+ # load the gem
901
+ require 'purecloud'
902
+ # setup authorization
903
+ @secret = ENV['PURECLOUD_SECRET']
904
+ @id = ENV['PURECLOUD_CLIENT_ID']
905
+ environment = "mypurecloud.com"
906
+
907
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
908
+
909
+ PureCloud.configure do |config|
910
+ config.access_token = @authToken
911
+ end
912
+
913
+ api_instance = PureCloud::AnalyticsApi.new
914
+
915
+ opts = {
916
+ body: PureCloud::ObservationQuery.new # ObservationQuery | query
917
+ }
918
+
919
+ begin
920
+ #Query for queue observations
921
+ result = api_instance.post_queues_observations_query(opts)
922
+ p result
923
+ rescue PureCloud::ApiError => e
924
+ puts "Exception when calling AnalyticsApi->post_queues_observations_query: #{e}"
925
+ end
926
+ ~~~
927
+
928
+ ### Parameters
929
+
930
+ Name | Type | Description | Notes
931
+ ------------- | ------------- | ------------- | -------------
932
+ **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional]
933
+ {: class="table table-striped"}
934
+
935
+
936
+ ### Return type
937
+
938
+ [**ObservationQueryResponse**](ObservationQueryResponse.html)
939
+
940
+ ### HTTP request headers
941
+
942
+ - **Content-Type**: application/json
943
+ - **Accept**: application/json
944
+
945
+
946
+
947
+ <a name="post_reporting_schedules"></a>
948
+
949
+ ## -[**ReportSchedule**](ReportSchedule.html) post_reporting_schedules(opts)
950
+
951
+ Create a scheduled report job
952
+
953
+ Create a scheduled report job.
954
+
955
+ ### Example
956
+ ~~~ruby
957
+ # load the gem
958
+ require 'purecloud'
959
+ # setup authorization
960
+ @secret = ENV['PURECLOUD_SECRET']
961
+ @id = ENV['PURECLOUD_CLIENT_ID']
962
+ environment = "mypurecloud.com"
963
+
964
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
965
+
966
+ PureCloud.configure do |config|
967
+ config.access_token = @authToken
968
+ end
969
+
970
+ api_instance = PureCloud::AnalyticsApi.new
971
+
972
+ opts = {
973
+ body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule
974
+ }
975
+
976
+ begin
977
+ #Create a scheduled report job
978
+ result = api_instance.post_reporting_schedules(opts)
979
+ p result
980
+ rescue PureCloud::ApiError => e
981
+ puts "Exception when calling AnalyticsApi->post_reporting_schedules: #{e}"
982
+ end
983
+ ~~~
984
+
985
+ ### Parameters
986
+
987
+ Name | Type | Description | Notes
988
+ ------------- | ------------- | ------------- | -------------
989
+ **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional]
990
+ {: class="table table-striped"}
991
+
992
+
993
+ ### Return type
994
+
995
+ [**ReportSchedule**](ReportSchedule.html)
996
+
997
+ ### HTTP request headers
998
+
999
+ - **Content-Type**: application/json
1000
+ - **Accept**: application/json
1001
+
1002
+
1003
+
1004
+ <a name="post_reporting_schedules_schedule_id_runreport"></a>
1005
+
1006
+ ## -[**RunNowResponse**](RunNowResponse.html) post_reporting_schedules_schedule_id_runreport(schedule_id)
1007
+
1008
+ Place a scheduled report immediately into the reporting queue
1009
+
1010
+
1011
+
1012
+ ### Example
1013
+ ~~~ruby
1014
+ # load the gem
1015
+ require 'purecloud'
1016
+ # setup authorization
1017
+ @secret = ENV['PURECLOUD_SECRET']
1018
+ @id = ENV['PURECLOUD_CLIENT_ID']
1019
+ environment = "mypurecloud.com"
1020
+
1021
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1022
+
1023
+ PureCloud.configure do |config|
1024
+ config.access_token = @authToken
1025
+ end
1026
+
1027
+ api_instance = PureCloud::AnalyticsApi.new
1028
+
1029
+ schedule_id = "schedule_id_example" # String | Schedule ID
1030
+
1031
+
1032
+ begin
1033
+ #Place a scheduled report immediately into the reporting queue
1034
+ result = api_instance.post_reporting_schedules_schedule_id_runreport(schedule_id)
1035
+ p result
1036
+ rescue PureCloud::ApiError => e
1037
+ puts "Exception when calling AnalyticsApi->post_reporting_schedules_schedule_id_runreport: #{e}"
1038
+ end
1039
+ ~~~
1040
+
1041
+ ### Parameters
1042
+
1043
+ Name | Type | Description | Notes
1044
+ ------------- | ------------- | ------------- | -------------
1045
+ **schedule_id** | **String**| Schedule ID |
1046
+ {: class="table table-striped"}
1047
+
1048
+
1049
+ ### Return type
1050
+
1051
+ [**RunNowResponse**](RunNowResponse.html)
1052
+
1053
+ ### HTTP request headers
1054
+
1055
+ - **Content-Type**: application/json
1056
+ - **Accept**: application/json
1057
+
1058
+
1059
+
1060
+ <a name="post_users_aggregates_query"></a>
1061
+
1062
+ ## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_users_aggregates_query(opts)
1063
+
1064
+ Query for user aggregates
1065
+
1066
+
1067
+
1068
+ ### Example
1069
+ ~~~ruby
1070
+ # load the gem
1071
+ require 'purecloud'
1072
+ # setup authorization
1073
+ @secret = ENV['PURECLOUD_SECRET']
1074
+ @id = ENV['PURECLOUD_CLIENT_ID']
1075
+ environment = "mypurecloud.com"
1076
+
1077
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1078
+
1079
+ PureCloud.configure do |config|
1080
+ config.access_token = @authToken
1081
+ end
1082
+
1083
+ api_instance = PureCloud::AnalyticsApi.new
1084
+
1085
+ opts = {
1086
+ body: PureCloud::AggregationQuery.new # AggregationQuery | query
1087
+ }
1088
+
1089
+ begin
1090
+ #Query for user aggregates
1091
+ result = api_instance.post_users_aggregates_query(opts)
1092
+ p result
1093
+ rescue PureCloud::ApiError => e
1094
+ puts "Exception when calling AnalyticsApi->post_users_aggregates_query: #{e}"
1095
+ end
1096
+ ~~~
1097
+
1098
+ ### Parameters
1099
+
1100
+ Name | Type | Description | Notes
1101
+ ------------- | ------------- | ------------- | -------------
1102
+ **body** | [**AggregationQuery**](AggregationQuery.html)| query | [optional]
1103
+ {: class="table table-striped"}
1104
+
1105
+
1106
+ ### Return type
1107
+
1108
+ [**PresenceQueryResponse**](PresenceQueryResponse.html)
1109
+
1110
+ ### HTTP request headers
1111
+
1112
+ - **Content-Type**: application/json
1113
+ - **Accept**: application/json
1114
+
1115
+
1116
+
1117
+ <a name="post_users_observations_query"></a>
1118
+
1119
+ ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_users_observations_query(opts)
1120
+
1121
+ Query for user observations
1122
+
1123
+
1124
+
1125
+ ### Example
1126
+ ~~~ruby
1127
+ # load the gem
1128
+ require 'purecloud'
1129
+ # setup authorization
1130
+ @secret = ENV['PURECLOUD_SECRET']
1131
+ @id = ENV['PURECLOUD_CLIENT_ID']
1132
+ environment = "mypurecloud.com"
1133
+
1134
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1135
+
1136
+ PureCloud.configure do |config|
1137
+ config.access_token = @authToken
1138
+ end
1139
+
1140
+ api_instance = PureCloud::AnalyticsApi.new
1141
+
1142
+ opts = {
1143
+ body: PureCloud::ObservationQuery.new # ObservationQuery | query
1144
+ }
1145
+
1146
+ begin
1147
+ #Query for user observations
1148
+ result = api_instance.post_users_observations_query(opts)
1149
+ p result
1150
+ rescue PureCloud::ApiError => e
1151
+ puts "Exception when calling AnalyticsApi->post_users_observations_query: #{e}"
1152
+ end
1153
+ ~~~
1154
+
1155
+ ### Parameters
1156
+
1157
+ Name | Type | Description | Notes
1158
+ ------------- | ------------- | ------------- | -------------
1159
+ **body** | [**ObservationQuery**](ObservationQuery.html)| query | [optional]
1160
+ {: class="table table-striped"}
1161
+
1162
+
1163
+ ### Return type
1164
+
1165
+ [**ObservationQueryResponse**](ObservationQueryResponse.html)
1166
+
1167
+ ### HTTP request headers
1168
+
1169
+ - **Content-Type**: application/json
1170
+ - **Accept**: application/json
1171
+
1172
+
1173
+
1174
+ <a name="put_reporting_schedules_schedule_id"></a>
1175
+
1176
+ ## -[**ReportSchedule**](ReportSchedule.html) put_reporting_schedules_schedule_id(schedule_id, opts)
1177
+
1178
+ Update a scheduled report job.
1179
+
1180
+
1181
+
1182
+ ### Example
1183
+ ~~~ruby
1184
+ # load the gem
1185
+ require 'purecloud'
1186
+ # setup authorization
1187
+ @secret = ENV['PURECLOUD_SECRET']
1188
+ @id = ENV['PURECLOUD_CLIENT_ID']
1189
+ environment = "mypurecloud.com"
1190
+
1191
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1192
+
1193
+ PureCloud.configure do |config|
1194
+ config.access_token = @authToken
1195
+ end
1196
+
1197
+ api_instance = PureCloud::AnalyticsApi.new
1198
+
1199
+ schedule_id = "schedule_id_example" # String | Schedule ID
1200
+
1201
+ opts = {
1202
+ body: PureCloud::ReportSchedule.new # ReportSchedule | ReportSchedule
1203
+ }
1204
+
1205
+ begin
1206
+ #Update a scheduled report job.
1207
+ result = api_instance.put_reporting_schedules_schedule_id(schedule_id, opts)
1208
+ p result
1209
+ rescue PureCloud::ApiError => e
1210
+ puts "Exception when calling AnalyticsApi->put_reporting_schedules_schedule_id: #{e}"
1211
+ end
1212
+ ~~~
1213
+
1214
+ ### Parameters
1215
+
1216
+ Name | Type | Description | Notes
1217
+ ------------- | ------------- | ------------- | -------------
1218
+ **schedule_id** | **String**| Schedule ID |
1219
+ **body** | [**ReportSchedule**](ReportSchedule.html)| ReportSchedule | [optional]
1220
+ {: class="table table-striped"}
1221
+
1222
+
1223
+ ### Return type
1224
+
1225
+ [**ReportSchedule**](ReportSchedule.html)
1226
+
1227
+ ### HTTP request headers
1228
+
1229
+ - **Content-Type**: application/json
1230
+ - **Accept**: application/json
1231
+
1232
+
1233
+