purecloud 0.45.1 → 0.46.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (549) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/index.html.md +3 -3
  5. data/lib/purecloud/api_client.rb +1 -1
  6. data/lib/purecloud/version.rb +1 -1
  7. data/lib/purecloud.rb +0 -269
  8. data/newVersion.md +1 -1
  9. data/swagger.json +1 -1
  10. data/version.json +1 -1
  11. metadata +2 -540
  12. data/doc_out/Account.html.md +0 -42
  13. data/doc_out/AccountManager.html.md +0 -16
  14. data/doc_out/AccountOverview.html.md +0 -20
  15. data/doc_out/AccountStatus.html.md +0 -21
  16. data/doc_out/AddressListing.html.md +0 -22
  17. data/doc_out/App.html.md +0 -14
  18. data/doc_out/ArchitectAuditMessage.html.md +0 -17
  19. data/doc_out/ArchitectAuditMessageListing.html.md +0 -17
  20. data/doc_out/Asset.html.md +0 -17
  21. data/doc_out/AssetEntityListing.html.md +0 -22
  22. data/doc_out/AssociatedDocument.html.md +0 -14
  23. data/doc_out/AuthzGrant.html.md +0 -15
  24. data/doc_out/AuthzGrantPolicy.html.md +0 -16
  25. data/doc_out/AuthzGrantRole.html.md +0 -17
  26. data/doc_out/AuthzObject.html.md +0 -17
  27. data/doc_out/AuthzPerm.html.md +0 -14
  28. data/doc_out/AuthzPermissionContext.html.md +0 -14
  29. data/doc_out/AuthzSubject.html.md +0 -16
  30. data/doc_out/AvailableAdditionalService.html.md +0 -22
  31. data/doc_out/AvailableAdditionalServiceListing.html.md +0 -22
  32. data/doc_out/BackendFlowAvailableActions.html.md +0 -13
  33. data/doc_out/BasicTransform.html.md +0 -14
  34. data/doc_out/BatchCommand.html.md +0 -14
  35. data/doc_out/BatchItem.html.md +0 -15
  36. data/doc_out/BatchItemBody.html.md +0 -13
  37. data/doc_out/BatchReply.html.md +0 -13
  38. data/doc_out/BatchReplyItem.html.md +0 -15
  39. data/doc_out/BillingAddress.html.md +0 -20
  40. data/doc_out/BillingContact.html.md +0 -20
  41. data/doc_out/BillingContactListing.html.md +0 -22
  42. data/doc_out/BillingPendingTask.html.md +0 -16
  43. data/doc_out/BillingPeriod.html.md +0 -17
  44. data/doc_out/BillingTaskResult.html.md +0 -21
  45. data/doc_out/Carrier.html.md +0 -20
  46. data/doc_out/CarrierAddress.html.md +0 -17
  47. data/doc_out/CarrierEntityListing.html.md +0 -22
  48. data/doc_out/Charge.html.md +0 -20
  49. data/doc_out/ClientSpreadsheetTransform.html.md +0 -19
  50. data/doc_out/ClientTextTableTransform.html.md +0 -20
  51. data/doc_out/CodesRequest.html.md +0 -14
  52. data/doc_out/ColumnCollapse.html.md +0 -14
  53. data/doc_out/ComposerTemplate.html.md +0 -22
  54. data/doc_out/ConsumedResourcesEntityListing.html.md +0 -22
  55. data/doc_out/ConsumingResourcesEntityListing.html.md +0 -22
  56. data/doc_out/ContactAddress.html.md +0 -18
  57. data/doc_out/ContactListing.html.md +0 -22
  58. data/doc_out/ContactSales.html.md +0 -25
  59. data/doc_out/ContactSalesResponse.html.md +0 -16
  60. data/doc_out/Contract.html.md +0 -18
  61. data/doc_out/ContractJob.html.md +0 -17
  62. data/doc_out/Control.html.md +0 -19
  63. data/doc_out/ControlOptions.html.md +0 -14
  64. data/doc_out/ConversationAssociation.html.md +0 -15
  65. data/doc_out/CreateIntegrationRequest.html.md +0 -16
  66. data/doc_out/CreateTemplateFromScriptRequestData.html.md +0 -17
  67. data/doc_out/CsvSchema.html.md +0 -19
  68. data/doc_out/Currency.html.md +0 -16
  69. data/doc_out/CustomerAccount.html.md +0 -21
  70. data/doc_out/DataItem.html.md +0 -15
  71. data/doc_out/DataValueInfo.html.md +0 -13
  72. data/doc_out/DeltaDocument.html.md +0 -19
  73. data/doc_out/DeltaRequest.html.md +0 -13
  74. data/doc_out/DeltaResponse.html.md +0 -15
  75. data/doc_out/Dependency.html.md +0 -19
  76. data/doc_out/DependencyObject.html.md +0 -21
  77. data/doc_out/DependencyObjectEntityListing.html.md +0 -22
  78. data/doc_out/DependencyStatus.html.md +0 -21
  79. data/doc_out/DependencyType.html.md +0 -16
  80. data/doc_out/DependencyTypeEntityListing.html.md +0 -22
  81. data/doc_out/Deployment.html.md +0 -17
  82. data/doc_out/DeploymentEntityListing.html.md +0 -22
  83. data/doc_out/DiagnosticEmail.html.md +0 -19
  84. data/doc_out/Discount.html.md +0 -20
  85. data/doc_out/Dns.html.md +0 -15
  86. data/doc_out/DocusignTemplateMapping.html.md +0 -16
  87. data/doc_out/DomainBillingPeriodEntityListing.html.md +0 -22
  88. data/doc_out/DomainInvoiceEntityListing.html.md +0 -22
  89. data/doc_out/DomainThirdPartyAccountEntityListing.html.md +0 -22
  90. data/doc_out/DomainThirdPartySubscriptionEntityListing.html.md +0 -22
  91. data/doc_out/DomainVoiceRateExtendedResponseItemEntityListing.html.md +0 -22
  92. data/doc_out/DomainVoiceRateInternationalResponseItemEntityListing.html.md +0 -22
  93. data/doc_out/DomainVoiceRateResponseItemEntityListing.html.md +0 -22
  94. data/doc_out/EmbeddedSignatureView.html.md +0 -14
  95. data/doc_out/ExpressionResponse.html.md +0 -23
  96. data/doc_out/ExternalContact.html.md +0 -32
  97. data/doc_out/ExternalDataSource.html.md +0 -14
  98. data/doc_out/ExternalOrganization.html.md +0 -30
  99. data/doc_out/ExternalOrganizationListing.html.md +0 -22
  100. data/doc_out/FacetRequest.html.md +0 -19
  101. data/doc_out/FacetResult.html.md +0 -17
  102. data/doc_out/FacetResultItem.html.md +0 -19
  103. data/doc_out/FailedObject.html.md +0 -16
  104. data/doc_out/FavoriteTemplateRequestData.html.md +0 -13
  105. data/doc_out/FilterItem.html.md +0 -17
  106. data/doc_out/Flow.html.md +0 -29
  107. data/doc_out/FlowBody.html.md +0 -14
  108. data/doc_out/FlowBodyFormat.html.md +0 -14
  109. data/doc_out/FlowConfigId.html.md +0 -16
  110. data/doc_out/FlowConfigMetaData.html.md +0 -23
  111. data/doc_out/FlowConfigMetaDataEntityListing.html.md +0 -22
  112. data/doc_out/FlowDetails.html.md +0 -24
  113. data/doc_out/FlowDetailsSearchResult.html.md +0 -14
  114. data/doc_out/FlowEntityListing.html.md +0 -22
  115. data/doc_out/FlowExecId.html.md +0 -15
  116. data/doc_out/FlowHistoryDataItem.html.md +0 -15
  117. data/doc_out/FlowHistoryItem.html.md +0 -20
  118. data/doc_out/FlowHistoryResultItem.html.md +0 -15
  119. data/doc_out/FlowInputData.html.md +0 -13
  120. data/doc_out/FlowLaunchRequest.html.md +0 -16
  121. data/doc_out/FlowPublish.html.md +0 -17
  122. data/doc_out/FlowReportResultItem.html.md +0 -24
  123. data/doc_out/FlowSearchRequest.html.md +0 -19
  124. data/doc_out/FlowState.html.md +0 -15
  125. data/doc_out/FlowTerminateRequest.html.md +0 -13
  126. data/doc_out/FlowUploadResponse.html.md +0 -14
  127. data/doc_out/FlowVersion.html.md +0 -23
  128. data/doc_out/FlowVersionConfigMetaData.html.md +0 -20
  129. data/doc_out/FlowVersionConfigMetaDataEntityListing.html.md +0 -22
  130. data/doc_out/FlowVersionEntityListing.html.md +0 -22
  131. data/doc_out/Form.html.md +0 -13
  132. data/doc_out/Gateway.html.md +0 -15
  133. data/doc_out/Gistener.html.md +0 -25
  134. data/doc_out/GroupTag.html.md +0 -19
  135. data/doc_out/HIPAAConfig.html.md +0 -16
  136. data/doc_out/HardwareRate.html.md +0 -18
  137. data/doc_out/HardwareRateListing.html.md +0 -22
  138. data/doc_out/HealthCheckInfo.html.md +0 -21
  139. data/doc_out/IVR.html.md +0 -31
  140. data/doc_out/IVREntityListing.html.md +0 -22
  141. data/doc_out/IndexedTransform.html.md +0 -16
  142. data/doc_out/Integration.html.md +0 -20
  143. data/doc_out/IntegrationConfiguration.html.md +0 -20
  144. data/doc_out/IntegrationEntityListing.html.md +0 -22
  145. data/doc_out/IntegrationStatusInfo.html.md +0 -16
  146. data/doc_out/IntegrationType.html.md +0 -20
  147. data/doc_out/IntegrationTypeEntityListing.html.md +0 -22
  148. data/doc_out/Invoice.html.md +0 -21
  149. data/doc_out/License.html.md +0 -14
  150. data/doc_out/LicensesByPermission.html.md +0 -15
  151. data/doc_out/LinkedEntityListingFlowDetails.html.md +0 -22
  152. data/doc_out/LinkedEntityListingWorkItemSearchDetails.html.md +0 -22
  153. data/doc_out/ManagementUnit.html.md +0 -18
  154. data/doc_out/ManagementUnitTimezone.html.md +0 -13
  155. data/doc_out/NocSupport.html.md +0 -14
  156. data/doc_out/Note.html.md +0 -18
  157. data/doc_out/NoteListing.html.md +0 -22
  158. data/doc_out/NumberOrder.html.md +0 -29
  159. data/doc_out/NumberOrderRequest.html.md +0 -17
  160. data/doc_out/Operation.html.md +0 -16
  161. data/doc_out/Order.html.md +0 -17
  162. data/doc_out/OrgLicenseAssignment.html.md +0 -16
  163. data/doc_out/OrganizationCreate.html.md +0 -18
  164. data/doc_out/Page.html.md +0 -20
  165. data/doc_out/PaymentMethod.html.md +0 -21
  166. data/doc_out/PaymentMethodListing.html.md +0 -22
  167. data/doc_out/PaymentTokenProvider.html.md +0 -16
  168. data/doc_out/Permissions.html.md +0 -15
  169. data/doc_out/PhoneNumber.html.md +0 -18
  170. data/doc_out/PortBillingAddress.html.md +0 -17
  171. data/doc_out/PortContact.html.md +0 -14
  172. data/doc_out/Product.html.md +0 -17
  173. data/doc_out/Prompt.html.md +0 -18
  174. data/doc_out/PromptAsset.html.md +0 -24
  175. data/doc_out/PromptAssetEntityListing.html.md +0 -22
  176. data/doc_out/PromptEntityListing.html.md +0 -22
  177. data/doc_out/Publication.html.md +0 -20
  178. data/doc_out/PublishScriptRequestData.html.md +0 -14
  179. data/doc_out/PublishedResult.html.md +0 -18
  180. data/doc_out/Quote.html.md +0 -32
  181. data/doc_out/QuoteCharge.html.md +0 -25
  182. data/doc_out/QuoteListing.html.md +0 -22
  183. data/doc_out/Rate.html.md +0 -17
  184. data/doc_out/Relationship.html.md +0 -18
  185. data/doc_out/RelationshipListing.html.md +0 -22
  186. data/doc_out/ReportRequest.html.md +0 -18
  187. data/doc_out/Reservation.html.md +0 -16
  188. data/doc_out/Scene.html.md +0 -22
  189. data/doc_out/SceneEntityListing.html.md +0 -22
  190. data/doc_out/SceneGroup.html.md +0 -16
  191. data/doc_out/SceneGroupEntityListing.html.md +0 -22
  192. data/doc_out/Schedule.html.md +0 -28
  193. data/doc_out/ScheduleEntityListing.html.md +0 -22
  194. data/doc_out/ScheduleGroup.html.md +0 -27
  195. data/doc_out/ScheduleGroupEntityListing.html.md +0 -22
  196. data/doc_out/Script.html.md +0 -26
  197. data/doc_out/ScriptEntityListing.html.md +0 -22
  198. data/doc_out/Service.html.md +0 -22
  199. data/doc_out/ServiceEntityListing.html.md +0 -22
  200. data/doc_out/ServiceType.html.md +0 -19
  201. data/doc_out/SharedResponse.html.md +0 -17
  202. data/doc_out/SheetSchema.html.md +0 -18
  203. data/doc_out/SheetTransform.html.md +0 -15
  204. data/doc_out/SignatureDocumentInfo.html.md +0 -16
  205. data/doc_out/Snapshot.html.md +0 -15
  206. data/doc_out/SocialAccount.html.md +0 -24
  207. data/doc_out/SocialConversation.html.md +0 -17
  208. data/doc_out/SocialConversationEntityListing.html.md +0 -22
  209. data/doc_out/SocialMediaParticipant.html.md +0 -37
  210. data/doc_out/SocializeEntityFilter.html.md +0 -15
  211. data/doc_out/SocializeFilterRequest.html.md +0 -17
  212. data/doc_out/SortField.html.md +0 -14
  213. data/doc_out/SpreadsheetTransform.html.md +0 -21
  214. data/doc_out/SpreadsheetTransformEntityListing.html.md +0 -22
  215. data/doc_out/SubDataItem.html.md +0 -17
  216. data/doc_out/Support.html.md +0 -15
  217. data/doc_out/SupportCredit.html.md +0 -16
  218. data/doc_out/SupportCreditListing.html.md +0 -22
  219. data/doc_out/SystemPrompt.html.md +0 -17
  220. data/doc_out/SystemPromptAsset.html.md +0 -25
  221. data/doc_out/SystemPromptAssetEntityListing.html.md +0 -22
  222. data/doc_out/SystemPromptEntityListing.html.md +0 -22
  223. data/doc_out/TableTransform.html.md +0 -18
  224. data/doc_out/TagModel.html.md +0 -14
  225. data/doc_out/TemplateEntityListing.html.md +0 -22
  226. data/doc_out/TextTableTransform.html.md +0 -21
  227. data/doc_out/TextTableTransformEntityListing.html.md +0 -22
  228. data/doc_out/ThirdPartyAccount.html.md +0 -19
  229. data/doc_out/ThirdPartySubscription.html.md +0 -18
  230. data/doc_out/Thumbnail.html.md +0 -16
  231. data/doc_out/Ticker.html.md +0 -14
  232. data/doc_out/Tier.html.md +0 -14
  233. data/doc_out/TimeOffRequest.html.md +0 -30
  234. data/doc_out/TimeOffRequestList.html.md +0 -16
  235. data/doc_out/TimeOffRequestPatch.html.md +0 -13
  236. data/doc_out/Trace.html.md +0 -19
  237. data/doc_out/TraceList.html.md +0 -14
  238. data/doc_out/TransformEndpoint.html.md +0 -24
  239. data/doc_out/TransformLens.html.md +0 -14
  240. data/doc_out/TwitterExpression.html.md +0 -36
  241. data/doc_out/TwitterExpressionBuffer.html.md +0 -13
  242. data/doc_out/TwitterId.html.md +0 -17
  243. data/doc_out/UnpivotColumns.html.md +0 -13
  244. data/doc_out/UploadProgress.html.md +0 -19
  245. data/doc_out/UrlResponse.html.md +0 -13
  246. data/doc_out/UserActionCategory.html.md +0 -15
  247. data/doc_out/UserActionCategoryEntityListing.html.md +0 -22
  248. data/doc_out/UserActionMetadata.html.md +0 -22
  249. data/doc_out/UserActionMetadataEntityListing.html.md +0 -20
  250. data/doc_out/UserActionMetadataRequest.html.md +0 -18
  251. data/doc_out/UserLicenseAssignment.html.md +0 -17
  252. data/doc_out/Value.html.md +0 -19
  253. data/doc_out/VendorConnectionRequest.html.md +0 -15
  254. data/doc_out/VideoConversation.html.md +0 -17
  255. data/doc_out/VideoConversationEntityListing.html.md +0 -22
  256. data/doc_out/VideoMediaParticipant.html.md +0 -38
  257. data/doc_out/View.html.md +0 -13
  258. data/doc_out/VoiceRate.html.md +0 -22
  259. data/doc_out/VoiceRateExtended.html.md +0 -31
  260. data/doc_out/VoiceRateInternational.html.md +0 -24
  261. data/doc_out/VoiceRateInternationalEntityListing.html.md +0 -22
  262. data/doc_out/VoiceRateUpdate.html.md +0 -25
  263. data/doc_out/VoiceRatesCsv.html.md +0 -16
  264. data/doc_out/VoiceXmlOperation.html.md +0 -25
  265. data/doc_out/VoiceXmlOperationEntityListing.html.md +0 -22
  266. data/doc_out/Vpn.html.md +0 -15
  267. data/doc_out/Waypoint.html.md +0 -20
  268. data/doc_out/WaypointEntityListing.html.md +0 -22
  269. data/doc_out/WorkItem.html.md +0 -15
  270. data/doc_out/WorkItemActions.html.md +0 -13
  271. data/doc_out/WorkItemCache.html.md +0 -17
  272. data/doc_out/WorkItemCommand.html.md +0 -14
  273. data/doc_out/WorkItemCommandGroup.html.md +0 -15
  274. data/doc_out/WorkItemDefinition.html.md +0 -16
  275. data/doc_out/WorkItemDetails.html.md +0 -32
  276. data/doc_out/WorkItemSearchDetails.html.md +0 -13
  277. data/doc_out/WorkItemSearchDetailsSearchResult.html.md +0 -14
  278. data/doc_out/WorkItemSubmitRequest.html.md +0 -14
  279. data/doc_out/WorkItemTransferRequest.html.md +0 -14
  280. data/doc_out/XlsxSchema.html.md +0 -15
  281. data/lib/purecloud/models/account.rb +0 -481
  282. data/lib/purecloud/models/account_manager.rb +0 -195
  283. data/lib/purecloud/models/account_overview.rb +0 -243
  284. data/lib/purecloud/models/account_status.rb +0 -249
  285. data/lib/purecloud/models/address_listing.rb +0 -257
  286. data/lib/purecloud/models/app.rb +0 -175
  287. data/lib/purecloud/models/architect_audit_message.rb +0 -218
  288. data/lib/purecloud/models/architect_audit_message_listing.rb +0 -207
  289. data/lib/purecloud/models/asset.rb +0 -207
  290. data/lib/purecloud/models/asset_entity_listing.rb +0 -257
  291. data/lib/purecloud/models/associated_document.rb +0 -187
  292. data/lib/purecloud/models/authz_grant.rb +0 -186
  293. data/lib/purecloud/models/authz_grant_policy.rb +0 -197
  294. data/lib/purecloud/models/authz_grant_role.rb +0 -209
  295. data/lib/purecloud/models/authz_object.rb +0 -210
  296. data/lib/purecloud/models/authz_perm.rb +0 -177
  297. data/lib/purecloud/models/authz_permission_context.rb +0 -175
  298. data/lib/purecloud/models/authz_subject.rb +0 -199
  299. data/lib/purecloud/models/available_additional_service.rb +0 -272
  300. data/lib/purecloud/models/available_additional_service_listing.rb +0 -257
  301. data/lib/purecloud/models/backend_flow_available_actions.rb +0 -167
  302. data/lib/purecloud/models/basic_transform.rb +0 -179
  303. data/lib/purecloud/models/batch_command.rb +0 -177
  304. data/lib/purecloud/models/batch_item.rb +0 -185
  305. data/lib/purecloud/models/batch_item_body.rb +0 -165
  306. data/lib/purecloud/models/batch_reply.rb +0 -167
  307. data/lib/purecloud/models/batch_reply_item.rb +0 -185
  308. data/lib/purecloud/models/billing_address.rb +0 -242
  309. data/lib/purecloud/models/billing_contact.rb +0 -237
  310. data/lib/purecloud/models/billing_contact_listing.rb +0 -257
  311. data/lib/purecloud/models/billing_pending_task.rb +0 -197
  312. data/lib/purecloud/models/billing_period.rb +0 -209
  313. data/lib/purecloud/models/billing_task_result.rb +0 -265
  314. data/lib/purecloud/models/carrier.rb +0 -239
  315. data/lib/purecloud/models/carrier_address.rb +0 -205
  316. data/lib/purecloud/models/carrier_entity_listing.rb +0 -257
  317. data/lib/purecloud/models/charge.rb +0 -235
  318. data/lib/purecloud/models/client_spreadsheet_transform.rb +0 -233
  319. data/lib/purecloud/models/client_text_table_transform.rb +0 -239
  320. data/lib/purecloud/models/codes_request.rb +0 -175
  321. data/lib/purecloud/models/column_collapse.rb +0 -177
  322. data/lib/purecloud/models/composer_template.rb +0 -272
  323. data/lib/purecloud/models/consumed_resources_entity_listing.rb +0 -257
  324. data/lib/purecloud/models/consuming_resources_entity_listing.rb +0 -257
  325. data/lib/purecloud/models/contact_address.rb +0 -215
  326. data/lib/purecloud/models/contact_listing.rb +0 -257
  327. data/lib/purecloud/models/contact_sales.rb +0 -297
  328. data/lib/purecloud/models/contact_sales_response.rb +0 -197
  329. data/lib/purecloud/models/contract.rb +0 -220
  330. data/lib/purecloud/models/contract_job.rb +0 -217
  331. data/lib/purecloud/models/control.rb +0 -240
  332. data/lib/purecloud/models/control_options.rb +0 -175
  333. data/lib/purecloud/models/conversation_association.rb +0 -197
  334. data/lib/purecloud/models/create_integration_request.rb +0 -200
  335. data/lib/purecloud/models/create_template_from_script_request_data.rb +0 -207
  336. data/lib/purecloud/models/csv_schema.rb +0 -243
  337. data/lib/purecloud/models/currency.rb +0 -197
  338. data/lib/purecloud/models/customer_account.rb +0 -257
  339. data/lib/purecloud/models/data_item.rb +0 -185
  340. data/lib/purecloud/models/data_value_info.rb +0 -167
  341. data/lib/purecloud/models/delta_document.rb +0 -235
  342. data/lib/purecloud/models/delta_request.rb +0 -165
  343. data/lib/purecloud/models/delta_response.rb +0 -189
  344. data/lib/purecloud/models/dependency.rb +0 -240
  345. data/lib/purecloud/models/dependency_object.rb +0 -264
  346. data/lib/purecloud/models/dependency_object_entity_listing.rb +0 -257
  347. data/lib/purecloud/models/dependency_status.rb +0 -260
  348. data/lib/purecloud/models/dependency_type.rb +0 -199
  349. data/lib/purecloud/models/dependency_type_entity_listing.rb +0 -257
  350. data/lib/purecloud/models/deployment.rb +0 -209
  351. data/lib/purecloud/models/deployment_entity_listing.rb +0 -257
  352. data/lib/purecloud/models/diagnostic_email.rb +0 -258
  353. data/lib/purecloud/models/discount.rb +0 -239
  354. data/lib/purecloud/models/dns.rb +0 -185
  355. data/lib/purecloud/models/docusign_template_mapping.rb +0 -197
  356. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +0 -257
  357. data/lib/purecloud/models/domain_invoice_entity_listing.rb +0 -257
  358. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +0 -257
  359. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +0 -257
  360. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +0 -257
  361. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +0 -257
  362. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +0 -257
  363. data/lib/purecloud/models/embedded_signature_view.rb +0 -176
  364. data/lib/purecloud/models/expression_response.rb +0 -275
  365. data/lib/purecloud/models/external_contact.rb +0 -362
  366. data/lib/purecloud/models/external_data_source.rb +0 -176
  367. data/lib/purecloud/models/external_organization.rb +0 -348
  368. data/lib/purecloud/models/external_organization_listing.rb +0 -257
  369. data/lib/purecloud/models/facet_request.rb +0 -251
  370. data/lib/purecloud/models/facet_result.rb +0 -230
  371. data/lib/purecloud/models/facet_result_item.rb +0 -227
  372. data/lib/purecloud/models/failed_object.rb +0 -195
  373. data/lib/purecloud/models/favorite_template_request_data.rb +0 -165
  374. data/lib/purecloud/models/filter_item.rb +0 -227
  375. data/lib/purecloud/models/flow.rb +0 -351
  376. data/lib/purecloud/models/flow_body.rb +0 -179
  377. data/lib/purecloud/models/flow_body_format.rb +0 -175
  378. data/lib/purecloud/models/flow_config_id.rb +0 -199
  379. data/lib/purecloud/models/flow_config_meta_data.rb +0 -298
  380. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +0 -257
  381. data/lib/purecloud/models/flow_details.rb +0 -307
  382. data/lib/purecloud/models/flow_details_search_result.rb +0 -180
  383. data/lib/purecloud/models/flow_entity_listing.rb +0 -257
  384. data/lib/purecloud/models/flow_exec_id.rb +0 -188
  385. data/lib/purecloud/models/flow_history_data_item.rb +0 -189
  386. data/lib/purecloud/models/flow_history_item.rb +0 -257
  387. data/lib/purecloud/models/flow_history_result_item.rb +0 -191
  388. data/lib/purecloud/models/flow_input_data.rb +0 -169
  389. data/lib/purecloud/models/flow_launch_request.rb +0 -209
  390. data/lib/purecloud/models/flow_publish.rb +0 -210
  391. data/lib/purecloud/models/flow_report_result_item.rb +0 -299
  392. data/lib/purecloud/models/flow_search_request.rb +0 -241
  393. data/lib/purecloud/models/flow_state.rb +0 -189
  394. data/lib/purecloud/models/flow_terminate_request.rb +0 -167
  395. data/lib/purecloud/models/flow_upload_response.rb +0 -178
  396. data/lib/purecloud/models/flow_version.rb +0 -276
  397. data/lib/purecloud/models/flow_version_config_meta_data.rb +0 -243
  398. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +0 -257
  399. data/lib/purecloud/models/flow_version_entity_listing.rb +0 -257
  400. data/lib/purecloud/models/form.rb +0 -167
  401. data/lib/purecloud/models/gateway.rb +0 -185
  402. data/lib/purecloud/models/gistener.rb +0 -301
  403. data/lib/purecloud/models/group_tag.rb +0 -242
  404. data/lib/purecloud/models/hardware_rate.rb +0 -217
  405. data/lib/purecloud/models/hardware_rate_listing.rb +0 -257
  406. data/lib/purecloud/models/health_check_info.rb +0 -257
  407. data/lib/purecloud/models/hipaa_config.rb +0 -199
  408. data/lib/purecloud/models/indexed_transform.rb +0 -199
  409. data/lib/purecloud/models/integration.rb +0 -253
  410. data/lib/purecloud/models/integration_configuration.rb +0 -243
  411. data/lib/purecloud/models/integration_entity_listing.rb +0 -257
  412. data/lib/purecloud/models/integration_status_info.rb +0 -209
  413. data/lib/purecloud/models/integration_type.rb +0 -245
  414. data/lib/purecloud/models/integration_type_entity_listing.rb +0 -257
  415. data/lib/purecloud/models/invoice.rb +0 -249
  416. data/lib/purecloud/models/ivr.rb +0 -360
  417. data/lib/purecloud/models/ivr_entity_listing.rb +0 -257
  418. data/lib/purecloud/models/license.rb +0 -176
  419. data/lib/purecloud/models/licenses_by_permission.rb +0 -188
  420. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +0 -257
  421. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +0 -257
  422. data/lib/purecloud/models/management_unit.rb +0 -218
  423. data/lib/purecloud/models/management_unit_timezone.rb +0 -165
  424. data/lib/purecloud/models/noc_support.rb +0 -175
  425. data/lib/purecloud/models/note.rb +0 -219
  426. data/lib/purecloud/models/note_listing.rb +0 -257
  427. data/lib/purecloud/models/number_order.rb +0 -361
  428. data/lib/purecloud/models/number_order_request.rb +0 -220
  429. data/lib/purecloud/models/operation.rb +0 -195
  430. data/lib/purecloud/models/order.rb +0 -209
  431. data/lib/purecloud/models/org_license_assignment.rb +0 -197
  432. data/lib/purecloud/models/organization_create.rb +0 -224
  433. data/lib/purecloud/models/page.rb +0 -243
  434. data/lib/purecloud/models/payment_method.rb +0 -270
  435. data/lib/purecloud/models/payment_method_listing.rb +0 -257
  436. data/lib/purecloud/models/payment_token_provider.rb +0 -199
  437. data/lib/purecloud/models/permissions.rb +0 -188
  438. data/lib/purecloud/models/phone_number.rb +0 -217
  439. data/lib/purecloud/models/port_billing_address.rb +0 -205
  440. data/lib/purecloud/models/port_contact.rb +0 -175
  441. data/lib/purecloud/models/product.rb +0 -218
  442. data/lib/purecloud/models/prompt.rb +0 -219
  443. data/lib/purecloud/models/prompt_asset.rb +0 -281
  444. data/lib/purecloud/models/prompt_asset_entity_listing.rb +0 -257
  445. data/lib/purecloud/models/prompt_entity_listing.rb +0 -257
  446. data/lib/purecloud/models/publication.rb +0 -243
  447. data/lib/purecloud/models/publish_script_request_data.rb +0 -175
  448. data/lib/purecloud/models/published_result.rb +0 -227
  449. data/lib/purecloud/models/quote.rb +0 -390
  450. data/lib/purecloud/models/quote_charge.rb +0 -300
  451. data/lib/purecloud/models/quote_listing.rb +0 -257
  452. data/lib/purecloud/models/rate.rb +0 -209
  453. data/lib/purecloud/models/relationship.rb +0 -220
  454. data/lib/purecloud/models/relationship_listing.rb +0 -257
  455. data/lib/purecloud/models/report_request.rb +0 -229
  456. data/lib/purecloud/models/reservation.rb +0 -206
  457. data/lib/purecloud/models/scene.rb +0 -270
  458. data/lib/purecloud/models/scene_entity_listing.rb +0 -257
  459. data/lib/purecloud/models/scene_group.rb +0 -197
  460. data/lib/purecloud/models/scene_group_entity_listing.rb +0 -257
  461. data/lib/purecloud/models/schedule.rb +0 -333
  462. data/lib/purecloud/models/schedule_entity_listing.rb +0 -257
  463. data/lib/purecloud/models/schedule_group.rb +0 -322
  464. data/lib/purecloud/models/schedule_group_entity_listing.rb +0 -257
  465. data/lib/purecloud/models/script.rb +0 -303
  466. data/lib/purecloud/models/script_entity_listing.rb +0 -257
  467. data/lib/purecloud/models/service.rb +0 -264
  468. data/lib/purecloud/models/service_entity_listing.rb +0 -257
  469. data/lib/purecloud/models/service_type.rb +0 -230
  470. data/lib/purecloud/models/shared_response.rb +0 -205
  471. data/lib/purecloud/models/sheet_schema.rb +0 -232
  472. data/lib/purecloud/models/sheet_transform.rb +0 -185
  473. data/lib/purecloud/models/signature_document_info.rb +0 -196
  474. data/lib/purecloud/models/snapshot.rb +0 -187
  475. data/lib/purecloud/models/social_account.rb +0 -292
  476. data/lib/purecloud/models/social_conversation.rb +0 -213
  477. data/lib/purecloud/models/social_conversation_entity_listing.rb +0 -257
  478. data/lib/purecloud/models/social_media_participant.rb +0 -465
  479. data/lib/purecloud/models/socialize_entity_filter.rb +0 -197
  480. data/lib/purecloud/models/socialize_filter_request.rb +0 -217
  481. data/lib/purecloud/models/sort_field.rb +0 -184
  482. data/lib/purecloud/models/spreadsheet_transform.rb +0 -255
  483. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +0 -257
  484. data/lib/purecloud/models/sub_data_item.rb +0 -211
  485. data/lib/purecloud/models/support.rb +0 -185
  486. data/lib/purecloud/models/support_credit.rb +0 -197
  487. data/lib/purecloud/models/support_credit_listing.rb +0 -257
  488. data/lib/purecloud/models/system_prompt.rb +0 -209
  489. data/lib/purecloud/models/system_prompt_asset.rb +0 -302
  490. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +0 -257
  491. data/lib/purecloud/models/system_prompt_entity_listing.rb +0 -257
  492. data/lib/purecloud/models/table_transform.rb +0 -223
  493. data/lib/purecloud/models/tag_model.rb +0 -175
  494. data/lib/purecloud/models/template_entity_listing.rb +0 -257
  495. data/lib/purecloud/models/text_table_transform.rb +0 -251
  496. data/lib/purecloud/models/text_table_transform_entity_listing.rb +0 -257
  497. data/lib/purecloud/models/third_party_account.rb +0 -231
  498. data/lib/purecloud/models/third_party_subscription.rb +0 -218
  499. data/lib/purecloud/models/thumbnail.rb +0 -197
  500. data/lib/purecloud/models/ticker.rb +0 -177
  501. data/lib/purecloud/models/tier.rb +0 -175
  502. data/lib/purecloud/models/time_off_request.rb +0 -356
  503. data/lib/purecloud/models/time_off_request_list.rb +0 -199
  504. data/lib/purecloud/models/time_off_request_patch.rb +0 -167
  505. data/lib/purecloud/models/trace.rb +0 -235
  506. data/lib/purecloud/models/trace_list.rb +0 -177
  507. data/lib/purecloud/models/transform_endpoint.rb +0 -290
  508. data/lib/purecloud/models/transform_lens.rb +0 -175
  509. data/lib/purecloud/models/twitter_expression.rb +0 -431
  510. data/lib/purecloud/models/twitter_expression_buffer.rb +0 -168
  511. data/lib/purecloud/models/twitter_id.rb +0 -213
  512. data/lib/purecloud/models/unpivot_columns.rb +0 -167
  513. data/lib/purecloud/models/upload_progress.rb +0 -232
  514. data/lib/purecloud/models/url_response.rb +0 -165
  515. data/lib/purecloud/models/user_action_category.rb +0 -187
  516. data/lib/purecloud/models/user_action_category_entity_listing.rb +0 -257
  517. data/lib/purecloud/models/user_action_metadata.rb +0 -265
  518. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +0 -237
  519. data/lib/purecloud/models/user_action_metadata_request.rb +0 -215
  520. data/lib/purecloud/models/user_license_assignment.rb +0 -207
  521. data/lib/purecloud/models/value.rb +0 -239
  522. data/lib/purecloud/models/vendor_connection_request.rb +0 -185
  523. data/lib/purecloud/models/video_conversation.rb +0 -213
  524. data/lib/purecloud/models/video_conversation_entity_listing.rb +0 -257
  525. data/lib/purecloud/models/video_media_participant.rb +0 -482
  526. data/lib/purecloud/models/view.rb +0 -165
  527. data/lib/purecloud/models/voice_rate.rb +0 -273
  528. data/lib/purecloud/models/voice_rate_extended.rb +0 -374
  529. data/lib/purecloud/models/voice_rate_international.rb +0 -295
  530. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +0 -257
  531. data/lib/purecloud/models/voice_rate_update.rb +0 -301
  532. data/lib/purecloud/models/voice_rates_csv.rb +0 -199
  533. data/lib/purecloud/models/voice_xml_operation.rb +0 -314
  534. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +0 -257
  535. data/lib/purecloud/models/vpn.rb +0 -185
  536. data/lib/purecloud/models/waypoint.rb +0 -237
  537. data/lib/purecloud/models/waypoint_entity_listing.rb +0 -257
  538. data/lib/purecloud/models/work_item.rb +0 -189
  539. data/lib/purecloud/models/work_item_actions.rb +0 -167
  540. data/lib/purecloud/models/work_item_cache.rb +0 -212
  541. data/lib/purecloud/models/work_item_command.rb +0 -175
  542. data/lib/purecloud/models/work_item_command_group.rb +0 -187
  543. data/lib/purecloud/models/work_item_definition.rb +0 -200
  544. data/lib/purecloud/models/work_item_details.rb +0 -380
  545. data/lib/purecloud/models/work_item_search_details.rb +0 -166
  546. data/lib/purecloud/models/work_item_search_details_search_result.rb +0 -180
  547. data/lib/purecloud/models/work_item_submit_request.rb +0 -180
  548. data/lib/purecloud/models/work_item_transfer_request.rb +0 -187
  549. data/lib/purecloud/models/xlsx_schema.rb +0 -190
@@ -1,299 +0,0 @@
1
- =begin
2
- PureCloud Platform API
3
-
4
- With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
-
6
- OpenAPI spec version: v2
7
- Contact: DeveloperEvangelists@inin.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- License: ININ
11
- http://www.inin.com
12
-
13
- Terms of Service: https://developer.mypurecloud.com/tos
14
-
15
- =end
16
-
17
- require 'date'
18
-
19
- module PureCloud
20
- # Report for one active (running) process found in result to a report request.
21
- class FlowReportResultItem
22
- # The flow instance ID for this process
23
- attr_accessor :flow_exec_id
24
-
25
- # The flow config ID that this workitem was created from.
26
- attr_accessor :flow_config_id
27
-
28
- # The instance name for this flow in relation to its primary document. If the flow is not a document-centric type, this value will be empty.
29
- attr_accessor :flow_instance_name
30
-
31
- # the document for this flow (if this flow was launched via a document)
32
- attr_accessor :associated_document
33
-
34
- # The flow's running status, which indicates whether the flow is running normally or in error, etc;
35
- attr_accessor :flow_status
36
-
37
- # The current state of the flow (EG what action is being processed)
38
- attr_accessor :current_state
39
-
40
- # The time the flow was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
41
- attr_accessor :start_date_time
42
-
43
- # The time the flow ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
44
- attr_accessor :end_date_time
45
-
46
- # List of users currently assigned to a workItem
47
- attr_accessor :work_item_user_assignees
48
-
49
- # User that completed the flow
50
- attr_accessor :completed_user
51
-
52
- # Reason for completion
53
- attr_accessor :completion_reason
54
-
55
- # Additional information if the flow is in error
56
- attr_accessor :flow_error_info
57
-
58
- # Attribute mapping from ruby-style variable name to JSON key.
59
- def self.attribute_map
60
- {
61
-
62
- :'flow_exec_id' => :'flowExecId',
63
-
64
- :'flow_config_id' => :'flowConfigId',
65
-
66
- :'flow_instance_name' => :'flowInstanceName',
67
-
68
- :'associated_document' => :'associatedDocument',
69
-
70
- :'flow_status' => :'flowStatus',
71
-
72
- :'current_state' => :'currentState',
73
-
74
- :'start_date_time' => :'startDateTime',
75
-
76
- :'end_date_time' => :'endDateTime',
77
-
78
- :'work_item_user_assignees' => :'workItemUserAssignees',
79
-
80
- :'completed_user' => :'completedUser',
81
-
82
- :'completion_reason' => :'completionReason',
83
-
84
- :'flow_error_info' => :'flowErrorInfo'
85
-
86
- }
87
- end
88
-
89
- # Attribute type mapping.
90
- def self.swagger_types
91
- {
92
- :'flow_exec_id' => :'FlowExecId',
93
- :'flow_config_id' => :'FlowConfigId',
94
- :'flow_instance_name' => :'String',
95
- :'associated_document' => :'AssociatedDocument',
96
- :'flow_status' => :'String',
97
- :'current_state' => :'String',
98
- :'start_date_time' => :'DateTime',
99
- :'end_date_time' => :'DateTime',
100
- :'work_item_user_assignees' => :'Array<User>',
101
- :'completed_user' => :'User',
102
- :'completion_reason' => :'String',
103
- :'flow_error_info' => :'ErrorBody'
104
-
105
- }
106
- end
107
-
108
- def initialize(attributes = {})
109
- return unless attributes.is_a?(Hash)
110
-
111
- # convert string to symbol for hash key
112
- attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
113
-
114
-
115
- if attributes[:'flowExecId']
116
- self.flow_exec_id = attributes[:'flowExecId']
117
- end
118
-
119
- if attributes[:'flowConfigId']
120
- self.flow_config_id = attributes[:'flowConfigId']
121
- end
122
-
123
- if attributes[:'flowInstanceName']
124
- self.flow_instance_name = attributes[:'flowInstanceName']
125
- end
126
-
127
- if attributes[:'associatedDocument']
128
- self.associated_document = attributes[:'associatedDocument']
129
- end
130
-
131
- if attributes[:'flowStatus']
132
- self.flow_status = attributes[:'flowStatus']
133
- end
134
-
135
- if attributes[:'currentState']
136
- self.current_state = attributes[:'currentState']
137
- end
138
-
139
- if attributes[:'startDateTime']
140
- self.start_date_time = attributes[:'startDateTime']
141
- end
142
-
143
- if attributes[:'endDateTime']
144
- self.end_date_time = attributes[:'endDateTime']
145
- end
146
-
147
- if attributes[:'workItemUserAssignees']
148
- if (value = attributes[:'workItemUserAssignees']).is_a?(Array)
149
- self.work_item_user_assignees = value
150
- end
151
- end
152
-
153
- if attributes[:'completedUser']
154
- self.completed_user = attributes[:'completedUser']
155
- end
156
-
157
- if attributes[:'completionReason']
158
- self.completion_reason = attributes[:'completionReason']
159
- end
160
-
161
- if attributes[:'flowErrorInfo']
162
- self.flow_error_info = attributes[:'flowErrorInfo']
163
- end
164
-
165
- end
166
-
167
- # Custom attribute writer method checking allowed values (enum).
168
- def flow_status=(flow_status)
169
- allowed_values = ["UNKNOWN", "RUNNING", "ERROR", "TERMINATED", "COMPLETED"]
170
- if flow_status && !allowed_values.include?(flow_status)
171
- fail "invalid value for 'flow_status', must be one of #{allowed_values}"
172
- end
173
- @flow_status = flow_status
174
- end
175
-
176
- # Check equality by comparing each attribute.
177
- def ==(o)
178
- return true if self.equal?(o)
179
- self.class == o.class &&
180
- flow_exec_id == o.flow_exec_id &&
181
- flow_config_id == o.flow_config_id &&
182
- flow_instance_name == o.flow_instance_name &&
183
- associated_document == o.associated_document &&
184
- flow_status == o.flow_status &&
185
- current_state == o.current_state &&
186
- start_date_time == o.start_date_time &&
187
- end_date_time == o.end_date_time &&
188
- work_item_user_assignees == o.work_item_user_assignees &&
189
- completed_user == o.completed_user &&
190
- completion_reason == o.completion_reason &&
191
- flow_error_info == o.flow_error_info
192
- end
193
-
194
- # @see the `==` method
195
- def eql?(o)
196
- self == o
197
- end
198
-
199
- # Calculate hash code according to all attributes.
200
- def hash
201
- [flow_exec_id, flow_config_id, flow_instance_name, associated_document, flow_status, current_state, start_date_time, end_date_time, work_item_user_assignees, completed_user, completion_reason, flow_error_info].hash
202
- end
203
-
204
- # build the object from hash
205
- def build_from_hash(attributes)
206
- return nil unless attributes.is_a?(Hash)
207
- self.class.swagger_types.each_pair do |key, type|
208
- if type =~ /^Array<(.*)>/i
209
- if attributes[self.class.attribute_map[key]].is_a?(Array)
210
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
211
- else
212
- #TODO show warning in debug mode
213
- end
214
- elsif !attributes[self.class.attribute_map[key]].nil?
215
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
216
- else
217
- # data not found in attributes(hash), not an issue as the data can be optional
218
- end
219
- end
220
-
221
- self
222
- end
223
-
224
- def _deserialize(type, value)
225
- case type.to_sym
226
- when :DateTime
227
- DateTime.parse(value)
228
- when :Date
229
- Date.parse(value)
230
- when :String
231
- value.to_s
232
- when :Integer
233
- value.to_i
234
- when :Float
235
- value.to_f
236
- when :BOOLEAN
237
- if value.to_s =~ /^(true|t|yes|y|1)$/i
238
- true
239
- else
240
- false
241
- end
242
- when :Object
243
- # generic object (usually a Hash), return directly
244
- value
245
- when /\AArray<(?<inner_type>.+)>\z/
246
- inner_type = Regexp.last_match[:inner_type]
247
- value.map { |v| _deserialize(inner_type, v) }
248
- when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
249
- k_type = Regexp.last_match[:k_type]
250
- v_type = Regexp.last_match[:v_type]
251
- {}.tap do |hash|
252
- value.each do |k, v|
253
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
254
- end
255
- end
256
- else # model
257
- _model = Object.const_get("PureCloud").const_get(type).new
258
- _model.build_from_hash(value)
259
- end
260
- end
261
-
262
- def to_s
263
- to_hash.to_s
264
- end
265
-
266
- # to_body is an alias to to_body (backward compatibility))
267
- def to_body
268
- to_hash
269
- end
270
-
271
- # return the object in the form of hash
272
- def to_hash
273
- hash = {}
274
- self.class.attribute_map.each_pair do |attr, param|
275
- value = self.send(attr)
276
- next if value.nil?
277
- hash[param] = _to_hash(value)
278
- end
279
- hash
280
- end
281
-
282
- # Method to output non-array value in the form of hash
283
- # For object, use to_hash. Otherwise, just return the value
284
- def _to_hash(value)
285
- if value.is_a?(Array)
286
- value.compact.map{ |v| _to_hash(v) }
287
- elsif value.is_a?(Hash)
288
- {}.tap do |hash|
289
- value.each { |k, v| hash[k] = _to_hash(v) }
290
- end
291
- elsif value.respond_to? :to_hash
292
- value.to_hash
293
- else
294
- value
295
- end
296
- end
297
-
298
- end
299
- end
@@ -1,241 +0,0 @@
1
- =begin
2
- PureCloud Platform API
3
-
4
- With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
-
6
- OpenAPI spec version: v2
7
- Contact: DeveloperEvangelists@inin.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- License: ININ
11
- http://www.inin.com
12
-
13
- Terms of Service: https://developer.mypurecloud.com/tos
14
-
15
- =end
16
-
17
- require 'date'
18
-
19
- module PureCloud
20
- # Used to perform a search on various data stored in search engines
21
- class FlowSearchRequest
22
- # The search text to look for
23
- attr_accessor :search_phrase
24
-
25
- # The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31
26
- attr_accessor :page_number
27
-
28
- # Number of entries to return/calculate per page.
29
- attr_accessor :page_size
30
-
31
- # The fields to limit the searchPhrase search to
32
- attr_accessor :search_fields
33
-
34
- # List of facet requests to generate summary views from the search result set (if any)
35
- attr_accessor :facet_requests
36
-
37
- # sort the results on a field(s)
38
- attr_accessor :sort
39
-
40
- # You can also restrict the search to particular field values and ranges
41
- attr_accessor :filters
42
-
43
- # Attribute mapping from ruby-style variable name to JSON key.
44
- def self.attribute_map
45
- {
46
-
47
- :'search_phrase' => :'searchPhrase',
48
-
49
- :'page_number' => :'pageNumber',
50
-
51
- :'page_size' => :'pageSize',
52
-
53
- :'search_fields' => :'searchFields',
54
-
55
- :'facet_requests' => :'facetRequests',
56
-
57
- :'sort' => :'sort',
58
-
59
- :'filters' => :'filters'
60
-
61
- }
62
- end
63
-
64
- # Attribute type mapping.
65
- def self.swagger_types
66
- {
67
- :'search_phrase' => :'String',
68
- :'page_number' => :'Integer',
69
- :'page_size' => :'Integer',
70
- :'search_fields' => :'Array<String>',
71
- :'facet_requests' => :'Array<FacetRequest>',
72
- :'sort' => :'Array<SortField>',
73
- :'filters' => :'Array<FilterItem>'
74
-
75
- }
76
- end
77
-
78
- def initialize(attributes = {})
79
- return unless attributes.is_a?(Hash)
80
-
81
- # convert string to symbol for hash key
82
- attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
83
-
84
-
85
- if attributes[:'searchPhrase']
86
- self.search_phrase = attributes[:'searchPhrase']
87
- end
88
-
89
- if attributes[:'pageNumber']
90
- self.page_number = attributes[:'pageNumber']
91
- end
92
-
93
- if attributes[:'pageSize']
94
- self.page_size = attributes[:'pageSize']
95
- end
96
-
97
- if attributes[:'searchFields']
98
- if (value = attributes[:'searchFields']).is_a?(Array)
99
- self.search_fields = value
100
- end
101
- end
102
-
103
- if attributes[:'facetRequests']
104
- if (value = attributes[:'facetRequests']).is_a?(Array)
105
- self.facet_requests = value
106
- end
107
- end
108
-
109
- if attributes[:'sort']
110
- if (value = attributes[:'sort']).is_a?(Array)
111
- self.sort = value
112
- end
113
- end
114
-
115
- if attributes[:'filters']
116
- if (value = attributes[:'filters']).is_a?(Array)
117
- self.filters = value
118
- end
119
- end
120
-
121
- end
122
-
123
- # Check equality by comparing each attribute.
124
- def ==(o)
125
- return true if self.equal?(o)
126
- self.class == o.class &&
127
- search_phrase == o.search_phrase &&
128
- page_number == o.page_number &&
129
- page_size == o.page_size &&
130
- search_fields == o.search_fields &&
131
- facet_requests == o.facet_requests &&
132
- sort == o.sort &&
133
- filters == o.filters
134
- end
135
-
136
- # @see the `==` method
137
- def eql?(o)
138
- self == o
139
- end
140
-
141
- # Calculate hash code according to all attributes.
142
- def hash
143
- [search_phrase, page_number, page_size, search_fields, facet_requests, sort, filters].hash
144
- end
145
-
146
- # build the object from hash
147
- def build_from_hash(attributes)
148
- return nil unless attributes.is_a?(Hash)
149
- self.class.swagger_types.each_pair do |key, type|
150
- if type =~ /^Array<(.*)>/i
151
- if attributes[self.class.attribute_map[key]].is_a?(Array)
152
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
153
- else
154
- #TODO show warning in debug mode
155
- end
156
- elsif !attributes[self.class.attribute_map[key]].nil?
157
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
158
- else
159
- # data not found in attributes(hash), not an issue as the data can be optional
160
- end
161
- end
162
-
163
- self
164
- end
165
-
166
- def _deserialize(type, value)
167
- case type.to_sym
168
- when :DateTime
169
- DateTime.parse(value)
170
- when :Date
171
- Date.parse(value)
172
- when :String
173
- value.to_s
174
- when :Integer
175
- value.to_i
176
- when :Float
177
- value.to_f
178
- when :BOOLEAN
179
- if value.to_s =~ /^(true|t|yes|y|1)$/i
180
- true
181
- else
182
- false
183
- end
184
- when :Object
185
- # generic object (usually a Hash), return directly
186
- value
187
- when /\AArray<(?<inner_type>.+)>\z/
188
- inner_type = Regexp.last_match[:inner_type]
189
- value.map { |v| _deserialize(inner_type, v) }
190
- when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
191
- k_type = Regexp.last_match[:k_type]
192
- v_type = Regexp.last_match[:v_type]
193
- {}.tap do |hash|
194
- value.each do |k, v|
195
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
196
- end
197
- end
198
- else # model
199
- _model = Object.const_get("PureCloud").const_get(type).new
200
- _model.build_from_hash(value)
201
- end
202
- end
203
-
204
- def to_s
205
- to_hash.to_s
206
- end
207
-
208
- # to_body is an alias to to_body (backward compatibility))
209
- def to_body
210
- to_hash
211
- end
212
-
213
- # return the object in the form of hash
214
- def to_hash
215
- hash = {}
216
- self.class.attribute_map.each_pair do |attr, param|
217
- value = self.send(attr)
218
- next if value.nil?
219
- hash[param] = _to_hash(value)
220
- end
221
- hash
222
- end
223
-
224
- # Method to output non-array value in the form of hash
225
- # For object, use to_hash. Otherwise, just return the value
226
- def _to_hash(value)
227
- if value.is_a?(Array)
228
- value.compact.map{ |v| _to_hash(v) }
229
- elsif value.is_a?(Hash)
230
- {}.tap do |hash|
231
- value.each { |k, v| hash[k] = _to_hash(v) }
232
- end
233
- elsif value.respond_to? :to_hash
234
- value.to_hash
235
- else
236
- value
237
- end
238
- end
239
-
240
- end
241
- end