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
@@ -1,3 +1,19 @@
1
+ =begin
2
+ PureCloud API
3
+
4
+ PureCloud API
5
+
6
+ OpenAPI spec version: v1
7
+ Contact: chuck.pulfer@inin.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: ININ
11
+ http://www.inin.com
12
+
13
+ Terms of Service: http://www.inin.com
14
+
15
+ =end
16
+
1
17
  require "uri"
2
18
 
3
19
  module PureCloud
@@ -8,41 +24,44 @@ module PureCloud
8
24
  @api_client = api_client
9
25
  end
10
26
 
11
- # Get all of a Conversation's Recordings.
27
+ # Delete annotation
12
28
  #
13
29
  # @param conversation_id Conversation ID
30
+ # @param recording_id Recording ID
31
+ # @param annotation_id Annotation ID
14
32
  # @param [Hash] opts the optional parameters
15
- # @option opts [String] :format_id The desired media format (WEBM, WAV)
16
- # @return [Array<Recording>]
17
- def get_conversation_id_recordings(conversation_id, opts = {})
18
- data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts)
19
- return data
33
+ # @return [nil]
34
+ def delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
35
+ delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
36
+ return nil
20
37
  end
21
38
 
22
- # Get all of a Conversation&#39;s Recordings.
39
+ # Delete annotation
23
40
  #
24
41
  # @param conversation_id Conversation ID
42
+ # @param recording_id Recording ID
43
+ # @param annotation_id Annotation ID
25
44
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :format_id The desired media format (WEBM, WAV)
27
- # @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
28
- def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
45
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
46
+ def delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
29
47
  if @api_client.config.debugging
30
- @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings ..."
48
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id ..."
31
49
  end
32
50
 
33
51
  # verify the required parameter 'conversation_id' is set
34
- fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings" if conversation_id.nil?
52
+ fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
35
53
 
36
- if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
37
- fail 'invalid value for "format_id", must be one of WEBM, WAV'
38
- end
54
+ # verify the required parameter 'recording_id' is set
55
+ fail "Missing the required parameter 'recording_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
56
+
57
+ # verify the required parameter 'annotation_id' is set
58
+ fail "Missing the required parameter 'annotation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
39
59
 
40
60
  # resource path
41
- path = "/api/v2/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
61
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
42
62
 
43
63
  # query parameters
44
64
  query_params = {}
45
- query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
46
65
 
47
66
  # header parameters
48
67
  header_params = {}
@@ -61,67 +80,48 @@ module PureCloud
61
80
  # http body (model)
62
81
  post_body = nil
63
82
 
64
-
65
83
  auth_names = ['PureCloud Auth']
66
- data, status_code, headers = @api_client.call_api(:GET, path,
84
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
67
85
  :header_params => header_params,
68
86
  :query_params => query_params,
69
87
  :form_params => form_params,
70
88
  :body => post_body,
71
- :auth_names => auth_names,
72
- :return_type => 'Array<Recording>')
89
+ :auth_names => auth_names)
73
90
  if @api_client.config.debugging
74
- @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
91
+ @api_client.config.logger.debug "API called: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
92
  end
76
93
  return data, status_code, headers
77
94
  end
78
95
 
79
- # Gets a specific recording.
80
- #
81
- # @param conversation_id Conversation ID
82
- # @param recording_id Recording ID
96
+ # Delete media retention policies
97
+ # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
98
+ # @param ids
83
99
  # @param [Hash] opts the optional parameters
84
- # @option opts [String] :format_id The desired media format (WEBM, WAV)
85
- # @option opts [BOOLEAN] :download requesting a download format of the recording
86
- # @option opts [String] :file_name the name of the downloaded fileName
87
- # @return [nil]
88
- def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
89
- get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
90
- return nil
100
+ # @return [String]
101
+ def delete_mediaretentionpolicies(ids, opts = {})
102
+ data, status_code, headers = delete_mediaretentionpolicies_with_http_info(ids, opts)
103
+ return data
91
104
  end
92
105
 
93
- # Gets a specific recording.
94
- #
95
- # @param conversation_id Conversation ID
96
- # @param recording_id Recording ID
106
+ # Delete media retention policies
107
+ # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
108
+ # @param ids
97
109
  # @param [Hash] opts the optional parameters
98
- # @option opts [String] :format_id The desired media format (WEBM, WAV)
99
- # @option opts [BOOLEAN] :download requesting a download format of the recording
100
- # @option opts [String] :file_name the name of the downloaded fileName
101
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
102
- def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {})
110
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
111
+ def delete_mediaretentionpolicies_with_http_info(ids, opts = {})
103
112
  if @api_client.config.debugging
104
- @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..."
113
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies ..."
105
114
  end
106
115
 
107
- # verify the required parameter 'conversation_id' is set
108
- fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id" if conversation_id.nil?
109
-
110
- # verify the required parameter 'recording_id' is set
111
- fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id" if recording_id.nil?
112
-
113
- if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
114
- fail 'invalid value for "format_id", must be one of WEBM, WAV'
115
- end
116
+ # verify the required parameter 'ids' is set
117
+ fail "Missing the required parameter 'ids' when calling delete_mediaretentionpolicies" if ids.nil?
116
118
 
117
119
  # resource path
118
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
120
+ local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
119
121
 
120
122
  # query parameters
121
123
  query_params = {}
122
- query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
123
- query_params[:'download'] = opts[:'download'] if opts[:'download']
124
- query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
124
+ query_params[:'ids'] = ids
125
125
 
126
126
  # header parameters
127
127
  header_params = {}
@@ -140,55 +140,45 @@ module PureCloud
140
140
  # http body (model)
141
141
  post_body = nil
142
142
 
143
-
144
143
  auth_names = ['PureCloud Auth']
145
- data, status_code, headers = @api_client.call_api(:GET, path,
144
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
146
145
  :header_params => header_params,
147
146
  :query_params => query_params,
148
147
  :form_params => form_params,
149
148
  :body => post_body,
150
- :auth_names => auth_names)
149
+ :auth_names => auth_names,
150
+ :return_type => 'String')
151
151
  if @api_client.config.debugging
152
- @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
153
  end
154
154
  return data, status_code, headers
155
155
  end
156
156
 
157
- # Updates the retention records on a recording.
158
- # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
159
- # @param conversation_id Conversation ID
160
- # @param recording_id Recording ID
161
- # @param body recording
157
+ # Delete a media retention policy
158
+ #
159
+ # @param policy_id Policy ID
162
160
  # @param [Hash] opts the optional parameters
163
- # @return [nil]
164
- def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
165
- put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
166
- return nil
161
+ # @return [String]
162
+ def delete_mediaretentionpolicies_policy_id(policy_id, opts = {})
163
+ data, status_code, headers = delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
164
+ return data
167
165
  end
168
166
 
169
- # Updates the retention records on a recording.
170
- # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
171
- # @param conversation_id Conversation ID
172
- # @param recording_id Recording ID
173
- # @param body recording
167
+ # Delete a media retention policy
168
+ #
169
+ # @param policy_id Policy ID
174
170
  # @param [Hash] opts the optional parameters
175
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
176
- def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
171
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
172
+ def delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
177
173
  if @api_client.config.debugging
178
- @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..."
174
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies_policy_id ..."
179
175
  end
180
176
 
181
- # verify the required parameter 'conversation_id' is set
182
- fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id" if conversation_id.nil?
183
-
184
- # verify the required parameter 'recording_id' is set
185
- fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id" if recording_id.nil?
186
-
187
- # verify the required parameter 'body' is set
188
- fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id" if body.nil?
177
+ # verify the required parameter 'policy_id' is set
178
+ fail "Missing the required parameter 'policy_id' when calling delete_mediaretentionpolicies_policy_id" if policy_id.nil?
189
179
 
190
180
  # resource path
191
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
181
+ local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
192
182
 
193
183
  # query parameters
194
184
  query_params = {}
@@ -208,52 +198,47 @@ module PureCloud
208
198
  form_params = {}
209
199
 
210
200
  # http body (model)
211
- post_body = @api_client.object_to_http_body(body)
201
+ post_body = nil
212
202
 
213
-
214
203
  auth_names = ['PureCloud Auth']
215
- data, status_code, headers = @api_client.call_api(:PUT, path,
204
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
216
205
  :header_params => header_params,
217
206
  :query_params => query_params,
218
207
  :form_params => form_params,
219
208
  :body => post_body,
220
- :auth_names => auth_names)
209
+ :auth_names => auth_names,
210
+ :return_type => 'String')
221
211
  if @api_client.config.debugging
222
- @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
223
213
  end
224
214
  return data, status_code, headers
225
215
  end
226
216
 
227
- # Get annotations for recording
217
+ # deletes a single orphan recording
228
218
  #
229
- # @param conversation_id Conversation ID
230
- # @param recording_id Recording ID
219
+ # @param orphan_id Orphan ID
231
220
  # @param [Hash] opts the optional parameters
232
- # @return [Array<Annotation>]
233
- def get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
234
- data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
221
+ # @return [OrphanRecording]
222
+ def delete_orphan_id(orphan_id, opts = {})
223
+ data, status_code, headers = delete_orphan_id_with_http_info(orphan_id, opts)
235
224
  return data
236
225
  end
237
226
 
238
- # Get annotations for recording
227
+ # deletes a single orphan recording
239
228
  #
240
- # @param conversation_id Conversation ID
241
- # @param recording_id Recording ID
229
+ # @param orphan_id Orphan ID
242
230
  # @param [Hash] opts the optional parameters
243
- # @return [Array<(Array<Annotation>, Fixnum, Hash)>] Array<Annotation> data, response status code and response headers
244
- def get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
231
+ # @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
232
+ def delete_orphan_id_with_http_info(orphan_id, opts = {})
245
233
  if @api_client.config.debugging
246
- @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations ..."
234
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_orphan_id ..."
247
235
  end
248
236
 
249
- # verify the required parameter 'conversation_id' is set
250
- fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
251
-
252
- # verify the required parameter 'recording_id' is set
253
- fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
237
+ # verify the required parameter 'orphan_id' is set
238
+ fail "Missing the required parameter 'orphan_id' when calling delete_orphan_id" if orphan_id.nil?
254
239
 
255
240
  # resource path
256
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
241
+ local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
257
242
 
258
243
  # query parameters
259
244
  query_params = {}
@@ -275,56 +260,55 @@ module PureCloud
275
260
  # http body (model)
276
261
  post_body = nil
277
262
 
278
-
279
263
  auth_names = ['PureCloud Auth']
280
- data, status_code, headers = @api_client.call_api(:GET, path,
264
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
281
265
  :header_params => header_params,
282
266
  :query_params => query_params,
283
267
  :form_params => form_params,
284
268
  :body => post_body,
285
269
  :auth_names => auth_names,
286
- :return_type => 'Array<Annotation>')
270
+ :return_type => 'OrphanRecording')
287
271
  if @api_client.config.debugging
288
- @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
272
+ @api_client.config.logger.debug "API called: RecordingApi#delete_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
289
273
  end
290
274
  return data, status_code, headers
291
275
  end
292
276
 
293
- # Create annotation
277
+ # Get all of a Conversation's Recordings.
294
278
  #
295
279
  # @param conversation_id Conversation ID
296
- # @param recording_id Recording ID
297
280
  # @param [Hash] opts the optional parameters
298
- # @option opts [Annotation] :body annotation
299
- # @return [Annotation]
300
- def post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
301
- data, status_code, headers = post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
281
+ # @option opts [String] :format_id The desired media format (WEBM, WAV) (default to WEBM)
282
+ # @return [Array<Recording>]
283
+ def get_conversation_id_recordings(conversation_id, opts = {})
284
+ data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts)
302
285
  return data
303
286
  end
304
287
 
305
- # Create annotation
288
+ # Get all of a Conversation&#39;s Recordings.
306
289
  #
307
290
  # @param conversation_id Conversation ID
308
- # @param recording_id Recording ID
309
291
  # @param [Hash] opts the optional parameters
310
- # @option opts [Annotation] :body annotation
311
- # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
312
- def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
292
+ # @option opts [String] :format_id The desired media format (WEBM, WAV)
293
+ # @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
294
+ def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
313
295
  if @api_client.config.debugging
314
- @api_client.config.logger.debug "Calling API: RecordingApi#post_conversation_id_recordings_recording_id_annotations ..."
296
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings ..."
315
297
  end
316
298
 
317
299
  # verify the required parameter 'conversation_id' is set
318
- fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
300
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings" if conversation_id.nil?
319
301
 
320
- # verify the required parameter 'recording_id' is set
321
- fail "Missing the required parameter 'recording_id' when calling post_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
302
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
303
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
304
+ end
322
305
 
323
306
  # resource path
324
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
307
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
325
308
 
326
309
  # query parameters
327
310
  query_params = {}
311
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
328
312
 
329
313
  # header parameters
330
314
  header_params = {}
@@ -341,61 +325,68 @@ module PureCloud
341
325
  form_params = {}
342
326
 
343
327
  # http body (model)
344
- post_body = @api_client.object_to_http_body(opts[:'body'])
328
+ post_body = nil
345
329
 
346
-
347
330
  auth_names = ['PureCloud Auth']
348
- data, status_code, headers = @api_client.call_api(:POST, path,
331
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
349
332
  :header_params => header_params,
350
333
  :query_params => query_params,
351
334
  :form_params => form_params,
352
335
  :body => post_body,
353
336
  :auth_names => auth_names,
354
- :return_type => 'Annotation')
337
+ :return_type => 'Array<Recording>')
355
338
  if @api_client.config.debugging
356
- @api_client.config.logger.debug "API called: RecordingApi#post_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
339
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
357
340
  end
358
341
  return data, status_code, headers
359
342
  end
360
343
 
361
- # Get annotation
344
+ # Gets a specific recording.
362
345
  #
363
346
  # @param conversation_id Conversation ID
364
347
  # @param recording_id Recording ID
365
- # @param annotation_id Annotation ID
366
348
  # @param [Hash] opts the optional parameters
367
- # @return [Annotation]
368
- def get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
369
- data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
370
- return data
349
+ # @option opts [String] :format_id The desired media format (WEBM, WAV) (default to WEBM)
350
+ # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
351
+ # @option opts [String] :file_name the name of the downloaded fileName
352
+ # @return [nil]
353
+ def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
354
+ get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
355
+ return nil
371
356
  end
372
357
 
373
- # Get annotation
358
+ # Gets a specific recording.
374
359
  #
375
360
  # @param conversation_id Conversation ID
376
361
  # @param recording_id Recording ID
377
- # @param annotation_id Annotation ID
378
362
  # @param [Hash] opts the optional parameters
379
- # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
380
- def get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
363
+ # @option opts [String] :format_id The desired media format (WEBM, WAV)
364
+ # @option opts [BOOLEAN] :download requesting a download format of the recording
365
+ # @option opts [String] :file_name the name of the downloaded fileName
366
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
367
+ def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {})
381
368
  if @api_client.config.debugging
382
- @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id ..."
369
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..."
383
370
  end
384
371
 
385
372
  # verify the required parameter 'conversation_id' is set
386
- fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
373
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id" if conversation_id.nil?
387
374
 
388
375
  # verify the required parameter 'recording_id' is set
389
- fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
376
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id" if recording_id.nil?
390
377
 
391
- # verify the required parameter 'annotation_id' is set
392
- fail "Missing the required parameter 'annotation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
378
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
379
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
380
+ end
393
381
 
394
382
  # resource path
395
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
383
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
396
384
 
397
385
  # query parameters
398
386
  query_params = {}
387
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
388
+ query_params[:'download'] = opts[:'download'] if opts[:'download']
389
+ query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
399
390
 
400
391
  # header parameters
401
392
  header_params = {}
@@ -414,58 +405,49 @@ module PureCloud
414
405
  # http body (model)
415
406
  post_body = nil
416
407
 
417
-
418
408
  auth_names = ['PureCloud Auth']
419
- data, status_code, headers = @api_client.call_api(:GET, path,
409
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
420
410
  :header_params => header_params,
421
411
  :query_params => query_params,
422
412
  :form_params => form_params,
423
413
  :body => post_body,
424
- :auth_names => auth_names,
425
- :return_type => 'Annotation')
414
+ :auth_names => auth_names)
426
415
  if @api_client.config.debugging
427
- @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
416
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
428
417
  end
429
418
  return data, status_code, headers
430
419
  end
431
420
 
432
- # Update annotation
421
+ # Get annotations for recording
433
422
  #
434
423
  # @param conversation_id Conversation ID
435
424
  # @param recording_id Recording ID
436
- # @param annotation_id Annotation ID
437
425
  # @param [Hash] opts the optional parameters
438
- # @option opts [Annotation] :body annotation
439
- # @return [Annotation]
440
- def put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
441
- data, status_code, headers = put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
426
+ # @return [Array<Annotation>]
427
+ def get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
428
+ data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
442
429
  return data
443
430
  end
444
431
 
445
- # Update annotation
432
+ # Get annotations for recording
446
433
  #
447
434
  # @param conversation_id Conversation ID
448
435
  # @param recording_id Recording ID
449
- # @param annotation_id Annotation ID
450
436
  # @param [Hash] opts the optional parameters
451
- # @option opts [Annotation] :body annotation
452
- # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
453
- def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
437
+ # @return [Array<(Array<Annotation>, Fixnum, Hash)>] Array<Annotation> data, response status code and response headers
438
+ def get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
454
439
  if @api_client.config.debugging
455
- @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id ..."
440
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations ..."
456
441
  end
457
442
 
458
443
  # verify the required parameter 'conversation_id' is set
459
- fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
444
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
460
445
 
461
446
  # verify the required parameter 'recording_id' is set
462
- fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
463
-
464
- # verify the required parameter 'annotation_id' is set
465
- fail "Missing the required parameter 'annotation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
447
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
466
448
 
467
449
  # resource path
468
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
450
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
469
451
 
470
452
  # query parameters
471
453
  query_params = {}
@@ -485,58 +467,57 @@ module PureCloud
485
467
  form_params = {}
486
468
 
487
469
  # http body (model)
488
- post_body = @api_client.object_to_http_body(opts[:'body'])
470
+ post_body = nil
489
471
 
490
-
491
472
  auth_names = ['PureCloud Auth']
492
- data, status_code, headers = @api_client.call_api(:PUT, path,
473
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
493
474
  :header_params => header_params,
494
475
  :query_params => query_params,
495
476
  :form_params => form_params,
496
477
  :body => post_body,
497
478
  :auth_names => auth_names,
498
- :return_type => 'Annotation')
479
+ :return_type => 'Array<Annotation>')
499
480
  if @api_client.config.debugging
500
- @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
481
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
501
482
  end
502
483
  return data, status_code, headers
503
484
  end
504
485
 
505
- # Delete annotation
486
+ # Get annotation
506
487
  #
507
488
  # @param conversation_id Conversation ID
508
489
  # @param recording_id Recording ID
509
490
  # @param annotation_id Annotation ID
510
491
  # @param [Hash] opts the optional parameters
511
- # @return [nil]
512
- def delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
513
- delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
514
- return nil
492
+ # @return [Annotation]
493
+ def get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
494
+ data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
495
+ return data
515
496
  end
516
497
 
517
- # Delete annotation
498
+ # Get annotation
518
499
  #
519
500
  # @param conversation_id Conversation ID
520
501
  # @param recording_id Recording ID
521
502
  # @param annotation_id Annotation ID
522
503
  # @param [Hash] opts the optional parameters
523
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
524
- def delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
504
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
505
+ def get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
525
506
  if @api_client.config.debugging
526
- @api_client.config.logger.debug "Calling API: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id ..."
507
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id ..."
527
508
  end
528
509
 
529
510
  # verify the required parameter 'conversation_id' is set
530
- fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
511
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
531
512
 
532
513
  # verify the required parameter 'recording_id' is set
533
- fail "Missing the required parameter 'recording_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
514
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
534
515
 
535
516
  # verify the required parameter 'annotation_id' is set
536
- fail "Missing the required parameter 'annotation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
517
+ fail "Missing the required parameter 'annotation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
537
518
 
538
519
  # resource path
539
- path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
520
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
540
521
 
541
522
  # query parameters
542
523
  query_params = {}
@@ -558,37 +539,41 @@ module PureCloud
558
539
  # http body (model)
559
540
  post_body = nil
560
541
 
561
-
562
542
  auth_names = ['PureCloud Auth']
563
- data, status_code, headers = @api_client.call_api(:DELETE, path,
543
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
564
544
  :header_params => header_params,
565
545
  :query_params => query_params,
566
546
  :form_params => form_params,
567
547
  :body => post_body,
568
- :auth_names => auth_names)
548
+ :auth_names => auth_names,
549
+ :return_type => 'Annotation')
569
550
  if @api_client.config.debugging
570
- @api_client.config.logger.debug "API called: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
551
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
571
552
  end
572
553
  return data, status_code, headers
573
554
  end
574
555
 
575
- # Gets all orphan recordings
576
- #
556
+ # Gets media retention policy list with query options to filter on name and enabled.
557
+ # for a less verbose response, add summary=true to this endpoint
577
558
  # @param [Hash] opts the optional parameters
578
- # @option opts [Integer] :page_size The total page size requested
579
- # @option opts [Integer] :page_number The page number requested
559
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
560
+ # @option opts [Integer] :page_number The page number requested (default to 1)
580
561
  # @option opts [String] :sort_by variable name requested to sort by
581
562
  # @option opts [Array<String>] :expand variable name requested by expand list
582
563
  # @option opts [String] :next_page next page token
583
564
  # @option opts [String] :previous_page Previous page token
584
- # @return [OrphanRecordingListing]
585
- def get_orphanrecordings(opts = {})
586
- data, status_code, headers = get_orphanrecordings_with_http_info(opts)
565
+ # @option opts [String] :name the policy name - used for filtering results in searches.
566
+ # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
567
+ # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists. (default to false)
568
+ # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
569
+ # @return [PolicyEntityListing]
570
+ def get_mediaretentionpolicies(opts = {})
571
+ data, status_code, headers = get_mediaretentionpolicies_with_http_info(opts)
587
572
  return data
588
573
  end
589
574
 
590
- # Gets all orphan recordings
591
- #
575
+ # Gets media retention policy list with query options to filter on name and enabled.
576
+ # for a less verbose response, add summary=true to this endpoint
592
577
  # @param [Hash] opts the optional parameters
593
578
  # @option opts [Integer] :page_size The total page size requested
594
579
  # @option opts [Integer] :page_number The page number requested
@@ -596,14 +581,18 @@ module PureCloud
596
581
  # @option opts [Array<String>] :expand variable name requested by expand list
597
582
  # @option opts [String] :next_page next page token
598
583
  # @option opts [String] :previous_page Previous page token
599
- # @return [Array<(OrphanRecordingListing, Fixnum, Hash)>] OrphanRecordingListing data, response status code and response headers
600
- def get_orphanrecordings_with_http_info(opts = {})
584
+ # @option opts [String] :name the policy name - used for filtering results in searches.
585
+ # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
586
+ # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists.
587
+ # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
588
+ # @return [Array<(PolicyEntityListing, Fixnum, Hash)>] PolicyEntityListing data, response status code and response headers
589
+ def get_mediaretentionpolicies_with_http_info(opts = {})
601
590
  if @api_client.config.debugging
602
- @api_client.config.logger.debug "Calling API: RecordingApi#get_orphanrecordings ..."
591
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies ..."
603
592
  end
604
593
 
605
594
  # resource path
606
- path = "/api/v2/orphanrecordings".sub('{format}','json')
595
+ local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
607
596
 
608
597
  # query parameters
609
598
  query_params = {}
@@ -613,6 +602,10 @@ module PureCloud
613
602
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
614
603
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
615
604
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
605
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
606
+ query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled']
607
+ query_params[:'summary'] = opts[:'summary'] if opts[:'summary']
608
+ query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors']
616
609
 
617
610
  # header parameters
618
611
  header_params = {}
@@ -631,46 +624,45 @@ module PureCloud
631
624
  # http body (model)
632
625
  post_body = nil
633
626
 
634
-
635
627
  auth_names = ['PureCloud Auth']
636
- data, status_code, headers = @api_client.call_api(:GET, path,
628
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
637
629
  :header_params => header_params,
638
630
  :query_params => query_params,
639
631
  :form_params => form_params,
640
632
  :body => post_body,
641
633
  :auth_names => auth_names,
642
- :return_type => 'OrphanRecordingListing')
634
+ :return_type => 'PolicyEntityListing')
643
635
  if @api_client.config.debugging
644
- @api_client.config.logger.debug "API called: RecordingApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
636
+ @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
645
637
  end
646
638
  return data, status_code, headers
647
639
  end
648
640
 
649
- # Gets a single orphan recording
641
+ # Get a media retention policy
650
642
  #
651
- # @param orphan_id Orphan ID
643
+ # @param policy_id Policy ID
652
644
  # @param [Hash] opts the optional parameters
653
- # @return [OrphanRecording]
654
- def get_orphan_id(orphan_id, opts = {})
655
- data, status_code, headers = get_orphan_id_with_http_info(orphan_id, opts)
645
+ # @return [Policy]
646
+ def get_mediaretentionpolicies_policy_id(policy_id, opts = {})
647
+ data, status_code, headers = get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
656
648
  return data
657
649
  end
658
650
 
659
- # Gets a single orphan recording
651
+ # Get a media retention policy
660
652
  #
661
- # @param orphan_id Orphan ID
653
+ # @param policy_id Policy ID
662
654
  # @param [Hash] opts the optional parameters
663
- # @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
664
- def get_orphan_id_with_http_info(orphan_id, opts = {})
655
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
656
+ def get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
665
657
  if @api_client.config.debugging
666
- @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id ..."
658
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies_policy_id ..."
667
659
  end
668
660
 
669
- # verify the required parameter 'orphan_id' is set
670
- fail "Missing the required parameter 'orphan_id' when calling get_orphan_id" if orphan_id.nil?
661
+ # verify the required parameter 'policy_id' is set
662
+ fail "Missing the required parameter 'policy_id' when calling get_mediaretentionpolicies_policy_id" if policy_id.nil?
671
663
 
672
664
  # resource path
673
- path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
665
+ local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
674
666
 
675
667
  # query parameters
676
668
  query_params = {}
@@ -692,46 +684,45 @@ module PureCloud
692
684
  # http body (model)
693
685
  post_body = nil
694
686
 
695
-
696
687
  auth_names = ['PureCloud Auth']
697
- data, status_code, headers = @api_client.call_api(:GET, path,
688
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
698
689
  :header_params => header_params,
699
690
  :query_params => query_params,
700
691
  :form_params => form_params,
701
692
  :body => post_body,
702
693
  :auth_names => auth_names,
703
- :return_type => 'OrphanRecording')
694
+ :return_type => 'Policy')
704
695
  if @api_client.config.debugging
705
- @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
696
+ @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
706
697
  end
707
698
  return data, status_code, headers
708
699
  end
709
700
 
710
- # deletes a single orphan recording
701
+ # Gets a single orphan recording
711
702
  #
712
703
  # @param orphan_id Orphan ID
713
704
  # @param [Hash] opts the optional parameters
714
705
  # @return [OrphanRecording]
715
- def delete_orphan_id(orphan_id, opts = {})
716
- data, status_code, headers = delete_orphan_id_with_http_info(orphan_id, opts)
706
+ def get_orphan_id(orphan_id, opts = {})
707
+ data, status_code, headers = get_orphan_id_with_http_info(orphan_id, opts)
717
708
  return data
718
709
  end
719
710
 
720
- # deletes a single orphan recording
711
+ # Gets a single orphan recording
721
712
  #
722
713
  # @param orphan_id Orphan ID
723
714
  # @param [Hash] opts the optional parameters
724
715
  # @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
725
- def delete_orphan_id_with_http_info(orphan_id, opts = {})
716
+ def get_orphan_id_with_http_info(orphan_id, opts = {})
726
717
  if @api_client.config.debugging
727
- @api_client.config.logger.debug "Calling API: RecordingApi#delete_orphan_id ..."
718
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id ..."
728
719
  end
729
720
 
730
721
  # verify the required parameter 'orphan_id' is set
731
- fail "Missing the required parameter 'orphan_id' when calling delete_orphan_id" if orphan_id.nil?
722
+ fail "Missing the required parameter 'orphan_id' when calling get_orphan_id" if orphan_id.nil?
732
723
 
733
724
  # resource path
734
- path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
725
+ local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
735
726
 
736
727
  # query parameters
737
728
  query_params = {}
@@ -753,9 +744,8 @@ module PureCloud
753
744
  # http body (model)
754
745
  post_body = nil
755
746
 
756
-
757
747
  auth_names = ['PureCloud Auth']
758
- data, status_code, headers = @api_client.call_api(:DELETE, path,
748
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
759
749
  :header_params => header_params,
760
750
  :query_params => query_params,
761
751
  :form_params => form_params,
@@ -763,32 +753,28 @@ module PureCloud
763
753
  :auth_names => auth_names,
764
754
  :return_type => 'OrphanRecording')
765
755
  if @api_client.config.debugging
766
- @api_client.config.logger.debug "API called: RecordingApi#delete_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
756
+ @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
767
757
  end
768
758
  return data, status_code, headers
769
759
  end
770
760
 
771
- # Gets media retention policy list with query options to filter on name and enabled.
772
- # for a less verbose response, add summary=true to this endpoint
761
+ # Gets all orphan recordings
762
+ #
773
763
  # @param [Hash] opts the optional parameters
774
- # @option opts [Integer] :page_size The total page size requested
775
- # @option opts [Integer] :page_number The page number requested
764
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
765
+ # @option opts [Integer] :page_number The page number requested (default to 1)
776
766
  # @option opts [String] :sort_by variable name requested to sort by
777
767
  # @option opts [Array<String>] :expand variable name requested by expand list
778
768
  # @option opts [String] :next_page next page token
779
769
  # @option opts [String] :previous_page Previous page token
780
- # @option opts [String] :name the policy name - used for filtering results in searches.
781
- # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
782
- # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists.
783
- # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
784
- # @return [PolicyEntityListing]
785
- def get_mediaretentionpolicies(opts = {})
786
- data, status_code, headers = get_mediaretentionpolicies_with_http_info(opts)
770
+ # @return [OrphanRecordingListing]
771
+ def get_orphanrecordings(opts = {})
772
+ data, status_code, headers = get_orphanrecordings_with_http_info(opts)
787
773
  return data
788
774
  end
789
775
 
790
- # Gets media retention policy list with query options to filter on name and enabled.
791
- # for a less verbose response, add summary=true to this endpoint
776
+ # Gets all orphan recordings
777
+ #
792
778
  # @param [Hash] opts the optional parameters
793
779
  # @option opts [Integer] :page_size The total page size requested
794
780
  # @option opts [Integer] :page_number The page number requested
@@ -796,18 +782,14 @@ module PureCloud
796
782
  # @option opts [Array<String>] :expand variable name requested by expand list
797
783
  # @option opts [String] :next_page next page token
798
784
  # @option opts [String] :previous_page Previous page token
799
- # @option opts [String] :name the policy name - used for filtering results in searches.
800
- # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
801
- # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists.
802
- # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
803
- # @return [Array<(PolicyEntityListing, Fixnum, Hash)>] PolicyEntityListing data, response status code and response headers
804
- def get_mediaretentionpolicies_with_http_info(opts = {})
785
+ # @return [Array<(OrphanRecordingListing, Fixnum, Hash)>] OrphanRecordingListing data, response status code and response headers
786
+ def get_orphanrecordings_with_http_info(opts = {})
805
787
  if @api_client.config.debugging
806
- @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies ..."
788
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_orphanrecordings ..."
807
789
  end
808
790
 
809
791
  # resource path
810
- path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
792
+ local_var_path = "/api/v2/orphanrecordings".sub('{format}','json')
811
793
 
812
794
  # query parameters
813
795
  query_params = {}
@@ -817,10 +799,6 @@ module PureCloud
817
799
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
818
800
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
819
801
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
820
- query_params[:'name'] = opts[:'name'] if opts[:'name']
821
- query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled']
822
- query_params[:'summary'] = opts[:'summary'] if opts[:'summary']
823
- query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors']
824
802
 
825
803
  # header parameters
826
804
  header_params = {}
@@ -839,46 +817,46 @@ module PureCloud
839
817
  # http body (model)
840
818
  post_body = nil
841
819
 
842
-
843
820
  auth_names = ['PureCloud Auth']
844
- data, status_code, headers = @api_client.call_api(:GET, path,
821
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
845
822
  :header_params => header_params,
846
823
  :query_params => query_params,
847
824
  :form_params => form_params,
848
825
  :body => post_body,
849
826
  :auth_names => auth_names,
850
- :return_type => 'PolicyEntityListing')
827
+ :return_type => 'OrphanRecordingListing')
851
828
  if @api_client.config.debugging
852
- @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
829
+ @api_client.config.logger.debug "API called: RecordingApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
853
830
  end
854
831
  return data, status_code, headers
855
832
  end
856
833
 
857
- # Create media retention policy
834
+ # Get the Recording Settings for the Organization
858
835
  #
859
836
  # @param [Hash] opts the optional parameters
860
- # @option opts [Policy] :body Policy
861
- # @return [Policy]
862
- def post_mediaretentionpolicies(opts = {})
863
- data, status_code, headers = post_mediaretentionpolicies_with_http_info(opts)
837
+ # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values (default to false)
838
+ # @return [RecordingSettings]
839
+ def get_settings(opts = {})
840
+ data, status_code, headers = get_settings_with_http_info(opts)
864
841
  return data
865
842
  end
866
843
 
867
- # Create media retention policy
844
+ # Get the Recording Settings for the Organization
868
845
  #
869
846
  # @param [Hash] opts the optional parameters
870
- # @option opts [Policy] :body Policy
871
- # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
872
- def post_mediaretentionpolicies_with_http_info(opts = {})
847
+ # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values
848
+ # @return [Array<(RecordingSettings, Fixnum, Hash)>] RecordingSettings data, response status code and response headers
849
+ def get_settings_with_http_info(opts = {})
873
850
  if @api_client.config.debugging
874
- @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..."
851
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_settings ..."
875
852
  end
876
853
 
877
854
  # resource path
878
- path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
855
+ local_var_path = "/api/v2/recording/settings".sub('{format}','json')
879
856
 
880
857
  # query parameters
881
858
  query_params = {}
859
+ query_params[:'createDefault'] = opts[:'create_default'] if opts[:'create_default']
882
860
 
883
861
  # header parameters
884
862
  header_params = {}
@@ -895,52 +873,52 @@ module PureCloud
895
873
  form_params = {}
896
874
 
897
875
  # http body (model)
898
- post_body = @api_client.object_to_http_body(opts[:'body'])
876
+ post_body = nil
899
877
 
900
-
901
878
  auth_names = ['PureCloud Auth']
902
- data, status_code, headers = @api_client.call_api(:POST, path,
879
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
903
880
  :header_params => header_params,
904
881
  :query_params => query_params,
905
882
  :form_params => form_params,
906
883
  :body => post_body,
907
884
  :auth_names => auth_names,
908
- :return_type => 'Policy')
885
+ :return_type => 'RecordingSettings')
909
886
  if @api_client.config.debugging
910
- @api_client.config.logger.debug "API called: RecordingApi#post_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
887
+ @api_client.config.logger.debug "API called: RecordingApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
911
888
  end
912
889
  return data, status_code, headers
913
890
  end
914
891
 
915
- # Delete media retention policies
916
- # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
917
- # @param ids
892
+ # Patch a media retention policy
893
+ #
894
+ # @param policy_id Policy ID
918
895
  # @param [Hash] opts the optional parameters
919
- # @return [String]
920
- def delete_mediaretentionpolicies(ids, opts = {})
921
- data, status_code, headers = delete_mediaretentionpolicies_with_http_info(ids, opts)
896
+ # @option opts [Policy] :body Policy
897
+ # @return [Policy]
898
+ def patch_mediaretentionpolicies_policy_id(policy_id, opts = {})
899
+ data, status_code, headers = patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
922
900
  return data
923
901
  end
924
902
 
925
- # Delete media retention policies
926
- # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
927
- # @param ids
903
+ # Patch a media retention policy
904
+ #
905
+ # @param policy_id Policy ID
928
906
  # @param [Hash] opts the optional parameters
929
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
930
- def delete_mediaretentionpolicies_with_http_info(ids, opts = {})
907
+ # @option opts [Policy] :body Policy
908
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
909
+ def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
931
910
  if @api_client.config.debugging
932
- @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies ..."
911
+ @api_client.config.logger.debug "Calling API: RecordingApi#patch_mediaretentionpolicies_policy_id ..."
933
912
  end
934
913
 
935
- # verify the required parameter 'ids' is set
936
- fail "Missing the required parameter 'ids' when calling delete_mediaretentionpolicies" if ids.nil?
914
+ # verify the required parameter 'policy_id' is set
915
+ fail "Missing the required parameter 'policy_id' when calling patch_mediaretentionpolicies_policy_id" if policy_id.nil?
937
916
 
938
917
  # resource path
939
- path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
918
+ local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
940
919
 
941
920
  # query parameters
942
921
  query_params = {}
943
- query_params[:'ids'] = ids
944
922
 
945
923
  # header parameters
946
924
  header_params = {}
@@ -957,48 +935,54 @@ module PureCloud
957
935
  form_params = {}
958
936
 
959
937
  # http body (model)
960
- post_body = nil
938
+ post_body = @api_client.object_to_http_body(opts[:'body'])
961
939
 
962
-
963
940
  auth_names = ['PureCloud Auth']
964
- data, status_code, headers = @api_client.call_api(:DELETE, path,
941
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
965
942
  :header_params => header_params,
966
943
  :query_params => query_params,
967
944
  :form_params => form_params,
968
945
  :body => post_body,
969
946
  :auth_names => auth_names,
970
- :return_type => 'String')
947
+ :return_type => 'Policy')
971
948
  if @api_client.config.debugging
972
- @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
949
+ @api_client.config.logger.debug "API called: RecordingApi#patch_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
973
950
  end
974
951
  return data, status_code, headers
975
952
  end
976
953
 
977
- # Get a media retention policy
954
+ # Create annotation
978
955
  #
979
- # @param policy_id Policy ID
956
+ # @param conversation_id Conversation ID
957
+ # @param recording_id Recording ID
980
958
  # @param [Hash] opts the optional parameters
981
- # @return [Policy]
982
- def get_mediaretentionpolicies_policy_id(policy_id, opts = {})
983
- data, status_code, headers = get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
959
+ # @option opts [Annotation] :body annotation
960
+ # @return [Annotation]
961
+ def post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
962
+ data, status_code, headers = post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
984
963
  return data
985
964
  end
986
965
 
987
- # Get a media retention policy
966
+ # Create annotation
988
967
  #
989
- # @param policy_id Policy ID
968
+ # @param conversation_id Conversation ID
969
+ # @param recording_id Recording ID
990
970
  # @param [Hash] opts the optional parameters
991
- # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
992
- def get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
971
+ # @option opts [Annotation] :body annotation
972
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
973
+ def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
993
974
  if @api_client.config.debugging
994
- @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies_policy_id ..."
975
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_conversation_id_recordings_recording_id_annotations ..."
995
976
  end
996
977
 
997
- # verify the required parameter 'policy_id' is set
998
- fail "Missing the required parameter 'policy_id' when calling get_mediaretentionpolicies_policy_id" if policy_id.nil?
978
+ # verify the required parameter 'conversation_id' is set
979
+ fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
980
+
981
+ # verify the required parameter 'recording_id' is set
982
+ fail "Missing the required parameter 'recording_id' when calling post_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
999
983
 
1000
984
  # resource path
1001
- path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
985
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
1002
986
 
1003
987
  # query parameters
1004
988
  query_params = {}
@@ -1018,50 +1002,44 @@ module PureCloud
1018
1002
  form_params = {}
1019
1003
 
1020
1004
  # http body (model)
1021
- post_body = nil
1005
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1022
1006
 
1023
-
1024
1007
  auth_names = ['PureCloud Auth']
1025
- data, status_code, headers = @api_client.call_api(:GET, path,
1008
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1026
1009
  :header_params => header_params,
1027
1010
  :query_params => query_params,
1028
1011
  :form_params => form_params,
1029
1012
  :body => post_body,
1030
1013
  :auth_names => auth_names,
1031
- :return_type => 'Policy')
1014
+ :return_type => 'Annotation')
1032
1015
  if @api_client.config.debugging
1033
- @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1016
+ @api_client.config.logger.debug "API called: RecordingApi#post_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1034
1017
  end
1035
1018
  return data, status_code, headers
1036
1019
  end
1037
1020
 
1038
- # Update a media retention policy
1021
+ # Create media retention policy
1039
1022
  #
1040
- # @param policy_id Policy ID
1041
1023
  # @param [Hash] opts the optional parameters
1042
1024
  # @option opts [Policy] :body Policy
1043
1025
  # @return [Policy]
1044
- def put_mediaretentionpolicies_policy_id(policy_id, opts = {})
1045
- data, status_code, headers = put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1026
+ def post_mediaretentionpolicies(opts = {})
1027
+ data, status_code, headers = post_mediaretentionpolicies_with_http_info(opts)
1046
1028
  return data
1047
1029
  end
1048
1030
 
1049
- # Update a media retention policy
1031
+ # Create media retention policy
1050
1032
  #
1051
- # @param policy_id Policy ID
1052
1033
  # @param [Hash] opts the optional parameters
1053
1034
  # @option opts [Policy] :body Policy
1054
1035
  # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
1055
- def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1036
+ def post_mediaretentionpolicies_with_http_info(opts = {})
1056
1037
  if @api_client.config.debugging
1057
- @api_client.config.logger.debug "Calling API: RecordingApi#put_mediaretentionpolicies_policy_id ..."
1038
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..."
1058
1039
  end
1059
1040
 
1060
- # verify the required parameter 'policy_id' is set
1061
- fail "Missing the required parameter 'policy_id' when calling put_mediaretentionpolicies_policy_id" if policy_id.nil?
1062
-
1063
1041
  # resource path
1064
- path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1042
+ local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json')
1065
1043
 
1066
1044
  # query parameters
1067
1045
  query_params = {}
@@ -1083,9 +1061,8 @@ module PureCloud
1083
1061
  # http body (model)
1084
1062
  post_body = @api_client.object_to_http_body(opts[:'body'])
1085
1063
 
1086
-
1087
1064
  auth_names = ['PureCloud Auth']
1088
- data, status_code, headers = @api_client.call_api(:PUT, path,
1065
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1089
1066
  :header_params => header_params,
1090
1067
  :query_params => query_params,
1091
1068
  :form_params => form_params,
@@ -1093,36 +1070,46 @@ module PureCloud
1093
1070
  :auth_names => auth_names,
1094
1071
  :return_type => 'Policy')
1095
1072
  if @api_client.config.debugging
1096
- @api_client.config.logger.debug "API called: RecordingApi#put_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1073
+ @api_client.config.logger.debug "API called: RecordingApi#post_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1097
1074
  end
1098
1075
  return data, status_code, headers
1099
1076
  end
1100
1077
 
1101
- # Delete a media retention policy
1102
- #
1103
- # @param policy_id Policy ID
1078
+ # Updates the retention records on a recording.
1079
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter 'restoreDays' is deprecated and will be removed in the next major version release. If 'restoreDays' is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate's time stamp in the PUT body to 10 days in the future.
1080
+ # @param conversation_id Conversation ID
1081
+ # @param recording_id Recording ID
1082
+ # @param body recording
1104
1083
  # @param [Hash] opts the optional parameters
1105
- # @return [String]
1106
- def delete_mediaretentionpolicies_policy_id(policy_id, opts = {})
1107
- data, status_code, headers = delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1108
- return data
1084
+ # @return [nil]
1085
+ def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
1086
+ put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
1087
+ return nil
1109
1088
  end
1110
1089
 
1111
- # Delete a media retention policy
1112
- #
1113
- # @param policy_id Policy ID
1090
+ # Updates the retention records on a recording.
1091
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
1092
+ # @param conversation_id Conversation ID
1093
+ # @param recording_id Recording ID
1094
+ # @param body recording
1114
1095
  # @param [Hash] opts the optional parameters
1115
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1116
- def delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1096
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1097
+ def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
1117
1098
  if @api_client.config.debugging
1118
- @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies_policy_id ..."
1099
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..."
1119
1100
  end
1120
1101
 
1121
- # verify the required parameter 'policy_id' is set
1122
- fail "Missing the required parameter 'policy_id' when calling delete_mediaretentionpolicies_policy_id" if policy_id.nil?
1102
+ # verify the required parameter 'conversation_id' is set
1103
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id" if conversation_id.nil?
1104
+
1105
+ # verify the required parameter 'recording_id' is set
1106
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id" if recording_id.nil?
1107
+
1108
+ # verify the required parameter 'body' is set
1109
+ fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id" if body.nil?
1123
1110
 
1124
1111
  # resource path
1125
- path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1112
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
1126
1113
 
1127
1114
  # query parameters
1128
1115
  query_params = {}
@@ -1142,50 +1129,58 @@ module PureCloud
1142
1129
  form_params = {}
1143
1130
 
1144
1131
  # http body (model)
1145
- post_body = nil
1132
+ post_body = @api_client.object_to_http_body(body)
1146
1133
 
1147
-
1148
1134
  auth_names = ['PureCloud Auth']
1149
- data, status_code, headers = @api_client.call_api(:DELETE, path,
1135
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1150
1136
  :header_params => header_params,
1151
1137
  :query_params => query_params,
1152
1138
  :form_params => form_params,
1153
1139
  :body => post_body,
1154
- :auth_names => auth_names,
1155
- :return_type => 'String')
1140
+ :auth_names => auth_names)
1156
1141
  if @api_client.config.debugging
1157
- @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1142
+ @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1158
1143
  end
1159
1144
  return data, status_code, headers
1160
1145
  end
1161
1146
 
1162
- # Patch a media retention policy
1147
+ # Update annotation
1163
1148
  #
1164
- # @param policy_id Policy ID
1149
+ # @param conversation_id Conversation ID
1150
+ # @param recording_id Recording ID
1151
+ # @param annotation_id Annotation ID
1165
1152
  # @param [Hash] opts the optional parameters
1166
- # @option opts [Policy] :body Policy
1167
- # @return [Policy]
1168
- def patch_mediaretentionpolicies_policy_id(policy_id, opts = {})
1169
- data, status_code, headers = patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1153
+ # @option opts [Annotation] :body annotation
1154
+ # @return [Annotation]
1155
+ def put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
1156
+ data, status_code, headers = put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
1170
1157
  return data
1171
1158
  end
1172
1159
 
1173
- # Patch a media retention policy
1160
+ # Update annotation
1174
1161
  #
1175
- # @param policy_id Policy ID
1162
+ # @param conversation_id Conversation ID
1163
+ # @param recording_id Recording ID
1164
+ # @param annotation_id Annotation ID
1176
1165
  # @param [Hash] opts the optional parameters
1177
- # @option opts [Policy] :body Policy
1178
- # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
1179
- def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1166
+ # @option opts [Annotation] :body annotation
1167
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
1168
+ def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
1180
1169
  if @api_client.config.debugging
1181
- @api_client.config.logger.debug "Calling API: RecordingApi#patch_mediaretentionpolicies_policy_id ..."
1170
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id ..."
1182
1171
  end
1183
1172
 
1184
- # verify the required parameter 'policy_id' is set
1185
- fail "Missing the required parameter 'policy_id' when calling patch_mediaretentionpolicies_policy_id" if policy_id.nil?
1173
+ # verify the required parameter 'conversation_id' is set
1174
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
1175
+
1176
+ # verify the required parameter 'recording_id' is set
1177
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
1178
+
1179
+ # verify the required parameter 'annotation_id' is set
1180
+ fail "Missing the required parameter 'annotation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
1186
1181
 
1187
1182
  # resource path
1188
- path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1183
+ local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
1189
1184
 
1190
1185
  # query parameters
1191
1186
  query_params = {}
@@ -1207,47 +1202,50 @@ module PureCloud
1207
1202
  # http body (model)
1208
1203
  post_body = @api_client.object_to_http_body(opts[:'body'])
1209
1204
 
1210
-
1211
1205
  auth_names = ['PureCloud Auth']
1212
- data, status_code, headers = @api_client.call_api(:PATCH, path,
1206
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1213
1207
  :header_params => header_params,
1214
1208
  :query_params => query_params,
1215
1209
  :form_params => form_params,
1216
1210
  :body => post_body,
1217
1211
  :auth_names => auth_names,
1218
- :return_type => 'Policy')
1212
+ :return_type => 'Annotation')
1219
1213
  if @api_client.config.debugging
1220
- @api_client.config.logger.debug "API called: RecordingApi#patch_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1214
+ @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1221
1215
  end
1222
1216
  return data, status_code, headers
1223
1217
  end
1224
1218
 
1225
- # Get the Recording Settings for the Organization
1219
+ # Update a media retention policy
1226
1220
  #
1221
+ # @param policy_id Policy ID
1227
1222
  # @param [Hash] opts the optional parameters
1228
- # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values
1229
- # @return [RecordingSettings]
1230
- def get_settings(opts = {})
1231
- data, status_code, headers = get_settings_with_http_info(opts)
1223
+ # @option opts [Policy] :body Policy
1224
+ # @return [Policy]
1225
+ def put_mediaretentionpolicies_policy_id(policy_id, opts = {})
1226
+ data, status_code, headers = put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1232
1227
  return data
1233
1228
  end
1234
1229
 
1235
- # Get the Recording Settings for the Organization
1230
+ # Update a media retention policy
1236
1231
  #
1232
+ # @param policy_id Policy ID
1237
1233
  # @param [Hash] opts the optional parameters
1238
- # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values
1239
- # @return [Array<(RecordingSettings, Fixnum, Hash)>] RecordingSettings data, response status code and response headers
1240
- def get_settings_with_http_info(opts = {})
1234
+ # @option opts [Policy] :body Policy
1235
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
1236
+ def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1241
1237
  if @api_client.config.debugging
1242
- @api_client.config.logger.debug "Calling API: RecordingApi#get_settings ..."
1238
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_mediaretentionpolicies_policy_id ..."
1243
1239
  end
1244
1240
 
1241
+ # verify the required parameter 'policy_id' is set
1242
+ fail "Missing the required parameter 'policy_id' when calling put_mediaretentionpolicies_policy_id" if policy_id.nil?
1243
+
1245
1244
  # resource path
1246
- path = "/api/v2/recording/settings".sub('{format}','json')
1245
+ local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1247
1246
 
1248
1247
  # query parameters
1249
1248
  query_params = {}
1250
- query_params[:'createDefault'] = opts[:'create_default'] if opts[:'create_default']
1251
1249
 
1252
1250
  # header parameters
1253
1251
  header_params = {}
@@ -1264,19 +1262,18 @@ module PureCloud
1264
1262
  form_params = {}
1265
1263
 
1266
1264
  # http body (model)
1267
- post_body = nil
1265
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1268
1266
 
1269
-
1270
1267
  auth_names = ['PureCloud Auth']
1271
- data, status_code, headers = @api_client.call_api(:GET, path,
1268
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1272
1269
  :header_params => header_params,
1273
1270
  :query_params => query_params,
1274
1271
  :form_params => form_params,
1275
1272
  :body => post_body,
1276
1273
  :auth_names => auth_names,
1277
- :return_type => 'RecordingSettings')
1274
+ :return_type => 'Policy')
1278
1275
  if @api_client.config.debugging
1279
- @api_client.config.logger.debug "API called: RecordingApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1276
+ @api_client.config.logger.debug "API called: RecordingApi#put_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1280
1277
  end
1281
1278
  return data, status_code, headers
1282
1279
  end
@@ -1302,7 +1299,7 @@ module PureCloud
1302
1299
  end
1303
1300
 
1304
1301
  # resource path
1305
- path = "/api/v2/recording/settings".sub('{format}','json')
1302
+ local_var_path = "/api/v2/recording/settings".sub('{format}','json')
1306
1303
 
1307
1304
  # query parameters
1308
1305
  query_params = {}
@@ -1324,9 +1321,8 @@ module PureCloud
1324
1321
  # http body (model)
1325
1322
  post_body = @api_client.object_to_http_body(opts[:'body'])
1326
1323
 
1327
-
1328
1324
  auth_names = ['PureCloud Auth']
1329
- data, status_code, headers = @api_client.call_api(:PUT, path,
1325
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1330
1326
  :header_params => header_params,
1331
1327
  :query_params => query_params,
1332
1328
  :form_params => form_params,
@@ -1340,7 +1336,3 @@ module PureCloud
1340
1336
  end
1341
1337
  end
1342
1338
  end
1343
-
1344
-
1345
-
1346
-