purecloud 0.69.1 → 0.70.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (288) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AgentActivityEntityListing.html.md +1 -1
  5. data/doc_out/ArchitectApi.html.md +1261 -0
  6. data/doc_out/AttemptLimitsEntityListing.html.md +1 -1
  7. data/doc_out/AttributeEntityListing.html.md +1 -1
  8. data/doc_out/CalibrationEntityListing.html.md +1 -1
  9. data/doc_out/CallConversationEntityListing.html.md +1 -1
  10. data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
  11. data/doc_out/CallbackConversationEntityListing.html.md +1 -1
  12. data/doc_out/CampaignEntityListing.html.md +1 -1
  13. data/doc_out/CampaignRuleAction.html.md +1 -1
  14. data/doc_out/CampaignRuleCondition.html.md +1 -1
  15. data/doc_out/CampaignRuleEntityListing.html.md +1 -1
  16. data/doc_out/CampaignRuleParameters.html.md +16 -0
  17. data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
  18. data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
  19. data/doc_out/ChatConversationEntityListing.html.md +1 -1
  20. data/doc_out/CobrowseConversationEntityListing.html.md +1 -1
  21. data/doc_out/CommandStatusEntityListing.html.md +1 -1
  22. data/doc_out/ContactListEntityListing.html.md +1 -1
  23. data/doc_out/ConversationEntityListing.html.md +1 -1
  24. data/doc_out/DIDEntityListing.html.md +1 -1
  25. data/doc_out/DIDPoolEntityListing.html.md +1 -1
  26. data/doc_out/DialerEventEntityListing.html.md +22 -0
  27. data/doc_out/DncListEntityListing.html.md +1 -1
  28. data/doc_out/DocumentAuditEntityListing.html.md +1 -1
  29. data/doc_out/DocumentEntityListing.html.md +1 -1
  30. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +1 -1
  31. data/doc_out/DomainEntityListing.html.md +1 -1
  32. data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
  33. data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
  34. data/doc_out/DomainOrganizationRole.html.md +1 -1
  35. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  36. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  37. data/doc_out/EdgeEntityListing.html.md +1 -1
  38. data/doc_out/EdgeGroupEntityListing.html.md +1 -1
  39. data/doc_out/EdgeLineEntityListing.html.md +1 -1
  40. data/doc_out/EmailConversationEntityListing.html.md +1 -1
  41. data/doc_out/EmailMessageListing.html.md +1 -1
  42. data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
  43. data/doc_out/EndpointEntityListing.html.md +1 -1
  44. data/doc_out/EvaluationEntityListing.html.md +1 -1
  45. data/doc_out/EvaluationFormEntityListing.html.md +1 -1
  46. data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
  47. data/doc_out/EventLog.html.md +22 -0
  48. data/doc_out/EventMessage.html.md +18 -0
  49. data/doc_out/ExtensionEntityListing.html.md +1 -1
  50. data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
  51. data/doc_out/FaxDocumentEntityListing.html.md +1 -1
  52. data/doc_out/Flow.html.md +28 -0
  53. data/doc_out/FlowEntityListing.html.md +22 -0
  54. data/doc_out/FlowVersion.html.md +24 -0
  55. data/doc_out/GreetingListing.html.md +1 -1
  56. data/doc_out/GroupEntityListing.html.md +1 -1
  57. data/doc_out/HeartBeatAlertContainer.html.md +1 -1
  58. data/doc_out/HeartBeatRuleContainer.html.md +1 -1
  59. data/doc_out/IdentityNow.html.md +20 -0
  60. data/doc_out/IdentityProviderApi.html.md +168 -0
  61. data/doc_out/InboundDomainEntityListing.html.md +1 -1
  62. data/doc_out/InboundRouteEntityListing.html.md +1 -1
  63. data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
  64. data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
  65. data/doc_out/JsonNode.html.md +5 -5
  66. data/doc_out/KeywordSetEntityListing.html.md +1 -1
  67. data/doc_out/LanguageEntityListing.html.md +1 -1
  68. data/doc_out/LibraryEntityListing.html.md +1 -1
  69. data/doc_out/LineBaseEntityListing.html.md +1 -1
  70. data/doc_out/LineEntityListing.html.md +1 -1
  71. data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
  72. data/doc_out/OAuthClientEntityListing.html.md +1 -1
  73. data/doc_out/OAuthProviderEntityListing.html.md +1 -1
  74. data/doc_out/Operation.html.md +21 -0
  75. data/doc_out/Organization.html.md +5 -4
  76. data/doc_out/OrganizationApi.html.md +61 -0
  77. data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
  78. data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
  79. data/doc_out/OrphanRecordingListing.html.md +1 -1
  80. data/doc_out/OutboundApi.html.md +129 -0
  81. data/doc_out/OutboundRouteBaseEntityListing.html.md +1 -1
  82. data/doc_out/OutboundRouteEntityListing.html.md +1 -1
  83. data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
  84. data/doc_out/PhoneBaseEntityListing.html.md +1 -1
  85. data/doc_out/PhoneEntityListing.html.md +1 -1
  86. data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
  87. data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
  88. data/doc_out/PolicyEntityListing.html.md +1 -1
  89. data/doc_out/Prompt.html.md +18 -0
  90. data/doc_out/PromptAsset.html.md +24 -0
  91. data/doc_out/PromptAssetCreate.html.md +24 -0
  92. data/doc_out/PromptAssetEntityListing.html.md +22 -0
  93. data/doc_out/PromptEntityListing.html.md +22 -0
  94. data/doc_out/QualityAuditPage.html.md +1 -1
  95. data/doc_out/QueueEntityListing.html.md +1 -1
  96. data/doc_out/QueueMemberEntityListing.html.md +1 -1
  97. data/doc_out/RecordingApi.html.md +5 -5
  98. data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
  99. data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
  100. data/doc_out/ReportScheduleEntityListing.html.md +1 -1
  101. data/doc_out/ResponseEntityList.html.md +1 -1
  102. data/doc_out/ResponseEntityListing.html.md +1 -1
  103. data/doc_out/ResponseSetEntityListing.html.md +1 -1
  104. data/doc_out/RoutingStatusAlertContainer.html.md +1 -1
  105. data/doc_out/RoutingStatusRuleContainer.html.md +1 -1
  106. data/doc_out/RuleSetEntityListing.html.md +1 -1
  107. data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
  108. data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
  109. data/doc_out/ScreenRecordingSessionListing.html.md +1 -1
  110. data/doc_out/ScriptEntityListing.html.md +1 -1
  111. data/doc_out/SecurityProfileEntityListing.html.md +1 -1
  112. data/doc_out/ShareEntityListing.html.md +1 -1
  113. data/doc_out/SiteEntityListing.html.md +1 -1
  114. data/doc_out/SkillEntityListing.html.md +1 -1
  115. data/doc_out/StationEntityListing.html.md +1 -1
  116. data/doc_out/SystemPrompt.html.md +17 -0
  117. data/doc_out/SystemPromptAsset.html.md +25 -0
  118. data/doc_out/SystemPromptAssetEntityListing.html.md +22 -0
  119. data/doc_out/SystemPromptEntityListing.html.md +22 -0
  120. data/doc_out/TagValueEntityListing.html.md +1 -1
  121. data/doc_out/TelephonyProvidersEdgeApi.html.md +0 -180
  122. data/doc_out/TimeZoneEntityListing.html.md +1 -1
  123. data/doc_out/TrunkBaseEntityListing.html.md +1 -1
  124. data/doc_out/TrunkEntityListing.html.md +1 -1
  125. data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
  126. data/doc_out/UserEntityListing.html.md +1 -1
  127. data/doc_out/UserPresenceAlertContainer.html.md +1 -1
  128. data/doc_out/UserPresenceRuleContainer.html.md +1 -1
  129. data/doc_out/UserQueueEntityListing.html.md +1 -1
  130. data/doc_out/UserRecordingEntityListing.html.md +1 -1
  131. data/doc_out/UserSkillEntityListing.html.md +1 -1
  132. data/doc_out/VisibilityCondition.html.md +1 -1
  133. data/doc_out/VoicemailMessageEntityListing.html.md +1 -1
  134. data/doc_out/WorkspaceEntityListing.html.md +1 -1
  135. data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
  136. data/doc_out/WrapupCodeEntityListing.html.md +1 -1
  137. data/doc_out/index.html.md +3 -3
  138. data/lib/purecloud.rb +19 -8
  139. data/lib/purecloud/api/architect_api.rb +1297 -0
  140. data/lib/purecloud/api/identity_provider_api.rb +170 -0
  141. data/lib/purecloud/api/organization_api.rb +57 -0
  142. data/lib/purecloud/api/outbound_api.rb +138 -0
  143. data/lib/purecloud/api/recording_api.rb +6 -6
  144. data/lib/purecloud/api/telephony_providers_edge_api.rb +0 -181
  145. data/lib/purecloud/api_client.rb +1 -1
  146. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/attempt_limits_entity_listing.rb +11 -11
  148. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  149. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  150. data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
  153. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  154. data/lib/purecloud/models/campaign_rule_action.rb +2 -4
  155. data/lib/purecloud/models/campaign_rule_condition.rb +2 -4
  156. data/lib/purecloud/models/campaign_rule_entity_listing.rb +11 -11
  157. data/lib/purecloud/models/{predicate.rb → campaign_rule_parameters.rb} +65 -14
  158. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  160. data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
  161. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +11 -11
  162. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  163. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  164. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  165. data/lib/purecloud/models/dialer_event_entity_listing.rb +257 -0
  166. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  167. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  168. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  169. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  170. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  171. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +11 -11
  172. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  173. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  174. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  175. data/lib/purecloud/models/domain_organization_role.rb +11 -11
  176. data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
  177. data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
  178. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  180. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
  182. data/lib/purecloud/models/email_message_listing.rb +11 -11
  183. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  184. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  185. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  186. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  188. data/lib/purecloud/models/event_log.rb +276 -0
  189. data/lib/purecloud/models/event_message.rb +228 -0
  190. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  191. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  192. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  193. data/lib/purecloud/models/flow.rb +329 -0
  194. data/lib/purecloud/models/{trunk_metrics_calls.rb → flow_entity_listing.rb} +96 -14
  195. data/lib/purecloud/models/flow_version.rb +286 -0
  196. data/lib/purecloud/models/greeting_listing.rb +11 -11
  197. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  198. data/lib/purecloud/models/heart_beat_alert_container.rb +11 -11
  199. data/lib/purecloud/models/heart_beat_rule_container.rb +11 -11
  200. data/lib/purecloud/models/{edge_offline_configuration.rb → identity_now.rb} +76 -16
  201. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  202. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  203. data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
  204. data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
  205. data/lib/purecloud/models/json_node.rb +39 -39
  206. data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
  207. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  208. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  209. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  210. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  211. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  212. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  213. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/operation.rb +269 -0
  215. data/lib/purecloud/models/organization.rb +27 -13
  216. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  217. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  219. data/lib/purecloud/models/outbound_route_base_entity_listing.rb +11 -11
  220. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  222. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  225. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  226. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  227. data/lib/purecloud/models/{edge_offline_configuration_interface.rb → prompt.rb} +50 -33
  228. data/lib/purecloud/models/prompt_asset.rb +279 -0
  229. data/lib/purecloud/models/prompt_asset_create.rb +280 -0
  230. data/lib/purecloud/models/prompt_asset_entity_listing.rb +257 -0
  231. data/lib/purecloud/models/prompt_entity_listing.rb +257 -0
  232. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  233. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/queue_member_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  237. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  238. data/lib/purecloud/models/response_entity_list.rb +11 -11
  239. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  241. data/lib/purecloud/models/routing_status_alert_container.rb +11 -11
  242. data/lib/purecloud/models/routing_status_rule_container.rb +11 -11
  243. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  245. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/screen_recording_session_listing.rb +11 -11
  247. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  248. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  249. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  250. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  251. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  252. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/{trunk_metrics.rb → system_prompt.rb} +36 -33
  254. data/lib/purecloud/models/system_prompt_asset.rb +299 -0
  255. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +257 -0
  256. data/lib/purecloud/models/system_prompt_entity_listing.rb +257 -0
  257. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  258. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  259. data/lib/purecloud/models/trunk_base_entity_listing.rb +11 -11
  260. data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  263. data/lib/purecloud/models/user_presence_alert_container.rb +11 -11
  264. data/lib/purecloud/models/user_presence_rule_container.rb +11 -11
  265. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  266. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  267. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  268. data/lib/purecloud/models/visibility_condition.rb +2 -1
  269. data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
  270. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  271. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  272. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  273. data/lib/purecloud/version.rb +1 -1
  274. data/newVersion.md +1 -1
  275. data/swagger.json +1 -1
  276. data/version.json +1 -1
  277. metadata +40 -18
  278. data/doc_out/EdgeOfflineConfiguration.html.md +0 -14
  279. data/doc_out/EdgeOfflineConfigurationInterface.html.md +0 -16
  280. data/doc_out/EdgeOfflineConfigurationNetwork.html.md +0 -13
  281. data/doc_out/EdgeOfflineConfigurationResponse.html.md +0 -13
  282. data/doc_out/Predicate.html.md +0 -14
  283. data/doc_out/TrunkMetrics.html.md +0 -17
  284. data/doc_out/TrunkMetricsCalls.html.md +0 -14
  285. data/doc_out/TrunkMetricsQoS.html.md +0 -13
  286. data/lib/purecloud/models/edge_offline_configuration_network.rb +0 -166
  287. data/lib/purecloud/models/edge_offline_configuration_response.rb +0 -166
  288. data/lib/purecloud/models/trunk_metrics_qo_s.rb +0 -166
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ed9aa05d287c8516c02ed155cc6b4302f2475319
4
- data.tar.gz: ed2c2049d7f465ff10b49f03b0e2368991d1a5c4
3
+ metadata.gz: 78b40f2eb833216793ab1a9fb8edc71ade5033a2
4
+ data.tar.gz: 304a4918aec7a6ce83c8fe1f4de5a5cdfa5b82a3
5
5
  SHA512:
6
- metadata.gz: 45f62741aed2064f5700cef58900dc581ca778f6b4920dfbcb768345b5d3d70a82ea92deae12eac0d0fd3598018bec40703eb2725a862091b286d17eb08be419
7
- data.tar.gz: e049b30136b04d4db359cac5df9e0e0b47b5d04ff17ecb97bbe6afaf6d0cc5b7e9684cdb0be82eb05498d584a01f5157634ebd4c2c8dc2d61f783f9168293e52
6
+ metadata.gz: 5a09d25ee3d04a5e89a31bfaac6ce1302381e6881bba176951bc416a6e199d0fa7b1d60698b07b77f3aaf8e7a97caaef119810164897813fe36227d668da0098
7
+ data.tar.gz: db8a226732ba3077de80ff048d2dcca16d162cc0a62baae4383d81189094249bece68cd81ba657089ce1f0cb0b154b638386d3b1723b9d6e4923b4667dd9b1bc
data/README.md CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.69.1
13
- - Build date: 2017-03-18T16:53:53.588Z
12
+ - Package version: 0.70.1
13
+ - Build date: 2017-03-27T18:30:29.702Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.69.1'
21
+ gem 'purecloud', '~> 0.70.1'
22
22
 
23
23
  ### Install from Git
24
24
 
@@ -1 +1 @@
1
- {"gemVersion":"0.69.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.69.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
1
+ {"gemVersion":"0.70.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.70.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
15
  | **self_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -0,0 +1,1261 @@
1
+ ---
2
+ title: ArchitectApi
3
+ ---
4
+
5
+ ## PureCloud::ArchitectApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**delete_prompts**](ArchitectApi.html#delete_prompts) | Batch-delete a list of prompts asynchronously
12
+ [**delete_prompts_prompt_id**](ArchitectApi.html#delete_prompts_prompt_id) | Delete specified user prompt
13
+ [**delete_prompts_prompt_id_resources_languagecode**](ArchitectApi.html#delete_prompts_prompt_id_resources_languagecode) | Delete specified user prompt resource
14
+ [**delete_systemprompts_prompt_id_resources_languagecode**](ArchitectApi.html#delete_systemprompts_prompt_id_resources_languagecode) | Delete a system prompt resource override.
15
+ [**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
16
+ [**get_prompts**](ArchitectApi.html#get_prompts) | Get a pageable list of user prompts
17
+ [**get_prompts_prompt_id**](ArchitectApi.html#get_prompts_prompt_id) | Get specified user prompt
18
+ [**get_prompts_prompt_id_resources**](ArchitectApi.html#get_prompts_prompt_id_resources) | Get a pageable list of user prompt resources
19
+ [**get_prompts_prompt_id_resources_languagecode**](ArchitectApi.html#get_prompts_prompt_id_resources_languagecode) | Get specified user prompt resource
20
+ [**get_systemprompts**](ArchitectApi.html#get_systemprompts) | Get System Prompts
21
+ [**get_systemprompts_prompt_id**](ArchitectApi.html#get_systemprompts_prompt_id) | Get a system prompt
22
+ [**get_systemprompts_prompt_id_resources**](ArchitectApi.html#get_systemprompts_prompt_id_resources) | Get IVR System Prompt resources.
23
+ [**get_systemprompts_prompt_id_resources_languagecode**](ArchitectApi.html#get_systemprompts_prompt_id_resources_languagecode) | Get a system prompt resource.
24
+ [**post_prompts**](ArchitectApi.html#post_prompts) | Create a new user prompt
25
+ [**post_prompts_prompt_id_resources**](ArchitectApi.html#post_prompts_prompt_id_resources) | Create a new user prompt resource
26
+ [**post_systemprompts_prompt_id_resources**](ArchitectApi.html#post_systemprompts_prompt_id_resources) | Create system prompt resource override.
27
+ [**put_prompts_prompt_id**](ArchitectApi.html#put_prompts_prompt_id) | Update specified user prompt
28
+ [**put_prompts_prompt_id_resources_languagecode**](ArchitectApi.html#put_prompts_prompt_id_resources_languagecode) | Update specified user prompt resource
29
+ [**put_systemprompts_prompt_id_resources_languagecode**](ArchitectApi.html#put_systemprompts_prompt_id_resources_languagecode) | Updates a system prompt resource override.
30
+ {: class="table table-striped"}
31
+
32
+ <a name="delete_prompts"></a>
33
+
34
+ ## -[**Operation**](Operation.html) delete_prompts(id)
35
+
36
+ Batch-delete a list of prompts asynchronously
37
+
38
+ Multiple IDs can be specified, in which case all specified prompts will be deleted.
39
+
40
+ Wraps DELETE /api/v2/architect/prompts
41
+
42
+
43
+ ### Example
44
+ ~~~ruby
45
+ # load the gem
46
+ require 'purecloud'
47
+ # setup authorization
48
+ @secret = ENV['PURECLOUD_SECRET']
49
+ @id = ENV['PURECLOUD_CLIENT_ID']
50
+ environment = "mypurecloud.com"
51
+
52
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
53
+
54
+ PureCloud.configure do |config|
55
+ config.access_token = @authToken
56
+ end
57
+
58
+ api_instance = PureCloud::ArchitectApi.new
59
+
60
+ id = ["id_example"] # Array<String> | List of Prompt IDs
61
+
62
+
63
+ begin
64
+ #Batch-delete a list of prompts asynchronously
65
+ result = api_instance.delete_prompts(id)
66
+ p result
67
+ rescue PureCloud::ApiError => e
68
+ puts "Exception when calling ArchitectApi->delete_prompts: #{e}"
69
+ end
70
+ ~~~
71
+
72
+ ### Parameters
73
+
74
+ Name | Type | Description | Notes
75
+ ------------- | ------------- | ------------- | -------------
76
+ **id** | [**Array&lt;String&gt;**](String.html)| List of Prompt IDs |
77
+ {: class="table table-striped"}
78
+
79
+
80
+ ### Return type
81
+
82
+ [**Operation**](Operation.html)
83
+
84
+ ### HTTP request headers
85
+
86
+ - **Content-Type**: application/json
87
+ - **Accept**: application/json
88
+
89
+
90
+
91
+ <a name="delete_prompts_prompt_id"></a>
92
+
93
+ ## - delete_prompts_prompt_id(prompt_id, opts)
94
+
95
+ Delete specified user prompt
96
+
97
+
98
+
99
+ Wraps DELETE /api/v2/architect/prompts/{promptId}
100
+
101
+
102
+ ### Example
103
+ ~~~ruby
104
+ # load the gem
105
+ require 'purecloud'
106
+ # setup authorization
107
+ @secret = ENV['PURECLOUD_SECRET']
108
+ @id = ENV['PURECLOUD_CLIENT_ID']
109
+ environment = "mypurecloud.com"
110
+
111
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
112
+
113
+ PureCloud.configure do |config|
114
+ config.access_token = @authToken
115
+ end
116
+
117
+ api_instance = PureCloud::ArchitectApi.new
118
+
119
+ prompt_id = "prompt_id_example" # String | Prompt ID
120
+
121
+ opts = {
122
+ all_resources: true # BOOLEAN | Whether or not to delete all the prompt resources
123
+ }
124
+
125
+ begin
126
+ #Delete specified user prompt
127
+ api_instance.delete_prompts_prompt_id(prompt_id, opts)
128
+ rescue PureCloud::ApiError => e
129
+ puts "Exception when calling ArchitectApi->delete_prompts_prompt_id: #{e}"
130
+ end
131
+ ~~~
132
+
133
+ ### Parameters
134
+
135
+ Name | Type | Description | Notes
136
+ ------------- | ------------- | ------------- | -------------
137
+ **prompt_id** | **String**| Prompt ID |
138
+ **all_resources** | **BOOLEAN**| Whether or not to delete all the prompt resources | [optional]
139
+ {: class="table table-striped"}
140
+
141
+
142
+ ### Return type
143
+
144
+ nil (empty response body)
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: application/json
149
+ - **Accept**: application/json
150
+
151
+
152
+
153
+ <a name="delete_prompts_prompt_id_resources_languagecode"></a>
154
+
155
+ ## - delete_prompts_prompt_id_resources_languagecode(prompt_id, language_code)
156
+
157
+ Delete specified user prompt resource
158
+
159
+
160
+
161
+ Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}
162
+
163
+
164
+ ### Example
165
+ ~~~ruby
166
+ # load the gem
167
+ require 'purecloud'
168
+ # setup authorization
169
+ @secret = ENV['PURECLOUD_SECRET']
170
+ @id = ENV['PURECLOUD_CLIENT_ID']
171
+ environment = "mypurecloud.com"
172
+
173
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
174
+
175
+ PureCloud.configure do |config|
176
+ config.access_token = @authToken
177
+ end
178
+
179
+ api_instance = PureCloud::ArchitectApi.new
180
+
181
+ prompt_id = "prompt_id_example" # String | Prompt ID
182
+
183
+ language_code = "language_code_example" # String | Language
184
+
185
+
186
+ begin
187
+ #Delete specified user prompt resource
188
+ api_instance.delete_prompts_prompt_id_resources_languagecode(prompt_id, language_code)
189
+ rescue PureCloud::ApiError => e
190
+ puts "Exception when calling ArchitectApi->delete_prompts_prompt_id_resources_languagecode: #{e}"
191
+ end
192
+ ~~~
193
+
194
+ ### Parameters
195
+
196
+ Name | Type | Description | Notes
197
+ ------------- | ------------- | ------------- | -------------
198
+ **prompt_id** | **String**| Prompt ID |
199
+ **language_code** | **String**| Language |
200
+ {: class="table table-striped"}
201
+
202
+
203
+ ### Return type
204
+
205
+ nil (empty response body)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
213
+
214
+ <a name="delete_systemprompts_prompt_id_resources_languagecode"></a>
215
+
216
+ ## -String** delete_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code)
217
+
218
+ Delete a system prompt resource override.
219
+
220
+
221
+
222
+ Wraps DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
223
+
224
+
225
+ ### Example
226
+ ~~~ruby
227
+ # load the gem
228
+ require 'purecloud'
229
+ # setup authorization
230
+ @secret = ENV['PURECLOUD_SECRET']
231
+ @id = ENV['PURECLOUD_CLIENT_ID']
232
+ environment = "mypurecloud.com"
233
+
234
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
235
+
236
+ PureCloud.configure do |config|
237
+ config.access_token = @authToken
238
+ end
239
+
240
+ api_instance = PureCloud::ArchitectApi.new
241
+
242
+ prompt_id = "prompt_id_example" # String | Prompt ID
243
+
244
+ language_code = "language_code_example" # String | Language
245
+
246
+
247
+ begin
248
+ #Delete a system prompt resource override.
249
+ result = api_instance.delete_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code)
250
+ p result
251
+ rescue PureCloud::ApiError => e
252
+ puts "Exception when calling ArchitectApi->delete_systemprompts_prompt_id_resources_languagecode: #{e}"
253
+ end
254
+ ~~~
255
+
256
+ ### Parameters
257
+
258
+ Name | Type | Description | Notes
259
+ ------------- | ------------- | ------------- | -------------
260
+ **prompt_id** | **String**| Prompt ID |
261
+ **language_code** | **String**| Language |
262
+ {: class="table table-striped"}
263
+
264
+
265
+ ### Return type
266
+
267
+ **String**
268
+
269
+ ### HTTP request headers
270
+
271
+ - **Content-Type**: application/json
272
+ - **Accept**: application/json
273
+
274
+
275
+
276
+ <a name="get_flows"></a>
277
+
278
+ ## -[**FlowEntityListing**](FlowEntityListing.html) get_flows(type, opts)
279
+
280
+ Get a pageable list of flows, filtered by query parameters
281
+
282
+ Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
283
+
284
+ Wraps GET /api/v2/flows
285
+
286
+
287
+ ### Example
288
+ ~~~ruby
289
+ # load the gem
290
+ require 'purecloud'
291
+ # setup authorization
292
+ @secret = ENV['PURECLOUD_SECRET']
293
+ @id = ENV['PURECLOUD_CLIENT_ID']
294
+ environment = "mypurecloud.com"
295
+
296
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
297
+
298
+ PureCloud.configure do |config|
299
+ config.access_token = @authToken
300
+ end
301
+
302
+ api_instance = PureCloud::ArchitectApi.new
303
+
304
+ type = "type_example" # String | Type
305
+
306
+ opts = {
307
+ page_number: 1, # Integer | Page number
308
+ page_size: 25, # Integer | Page size
309
+ sort_by: "id", # String | Sort by
310
+ sort_order: "asc", # String | Sort order
311
+ id: ["id_example"], # Array<String> | ID
312
+ name: "name_example", # String | Name
313
+ description: "description_example", # String | Description
314
+ name_or_description: "name_or_description_example", # String | Name or description
315
+ publish_version_id: "publish_version_id_example", # String | Publish version ID
316
+ editable_by: "editable_by_example", # String | Editable by
317
+ locked_by: "locked_by_example", # String | Locked by
318
+ secure: "secure_example", # String | Secure
319
+ deleted: false, # BOOLEAN | Include deleted
320
+ include_schemas: false # BOOLEAN | Include variable schemas
321
+ }
322
+
323
+ begin
324
+ #Get a pageable list of flows, filtered by query parameters
325
+ result = api_instance.get_flows(type, opts)
326
+ p result
327
+ rescue PureCloud::ApiError => e
328
+ puts "Exception when calling ArchitectApi->get_flows: #{e}"
329
+ end
330
+ ~~~
331
+
332
+ ### Parameters
333
+
334
+ Name | Type | Description | Notes
335
+ ------------- | ------------- | ------------- | -------------
336
+ **type** | **String**| Type |
337
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
338
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
339
+ **sort_by** | **String**| Sort by | [optional] [default to id]
340
+ **sort_order** | **String**| Sort order | [optional] [default to asc]
341
+ **id** | [**Array&lt;String&gt;**](String.html)| ID | [optional]
342
+ **name** | **String**| Name | [optional]
343
+ **description** | **String**| Description | [optional]
344
+ **name_or_description** | **String**| Name or description | [optional]
345
+ **publish_version_id** | **String**| Publish version ID | [optional]
346
+ **editable_by** | **String**| Editable by | [optional]
347
+ **locked_by** | **String**| Locked by | [optional]
348
+ **secure** | **String**| Secure | [optional]
349
+ **deleted** | **BOOLEAN**| Include deleted | [optional] [default to false]
350
+ **include_schemas** | **BOOLEAN**| Include variable schemas | [optional] [default to false]
351
+ {: class="table table-striped"}
352
+
353
+
354
+ ### Return type
355
+
356
+ [**FlowEntityListing**](FlowEntityListing.html)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: application/json
361
+ - **Accept**: application/json
362
+
363
+
364
+
365
+ <a name="get_prompts"></a>
366
+
367
+ ## -[**PromptEntityListing**](PromptEntityListing.html) get_prompts(opts)
368
+
369
+ Get a pageable list of user prompts
370
+
371
+ The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.
372
+
373
+ Wraps GET /api/v2/architect/prompts
374
+
375
+
376
+ ### Example
377
+ ~~~ruby
378
+ # load the gem
379
+ require 'purecloud'
380
+ # setup authorization
381
+ @secret = ENV['PURECLOUD_SECRET']
382
+ @id = ENV['PURECLOUD_CLIENT_ID']
383
+ environment = "mypurecloud.com"
384
+
385
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
386
+
387
+ PureCloud.configure do |config|
388
+ config.access_token = @authToken
389
+ end
390
+
391
+ api_instance = PureCloud::ArchitectApi.new
392
+
393
+ opts = {
394
+ page_number: 1, # Integer | Page number
395
+ page_size: 25, # Integer | Page size
396
+ name: "name_example", # String | Name
397
+ description: "description_example", # String | Description
398
+ name_or_description: "name_or_description_example" # String | Name or description
399
+ }
400
+
401
+ begin
402
+ #Get a pageable list of user prompts
403
+ result = api_instance.get_prompts(opts)
404
+ p result
405
+ rescue PureCloud::ApiError => e
406
+ puts "Exception when calling ArchitectApi->get_prompts: #{e}"
407
+ end
408
+ ~~~
409
+
410
+ ### Parameters
411
+
412
+ Name | Type | Description | Notes
413
+ ------------- | ------------- | ------------- | -------------
414
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
415
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
416
+ **name** | **String**| Name | [optional]
417
+ **description** | **String**| Description | [optional]
418
+ **name_or_description** | **String**| Name or description | [optional]
419
+ {: class="table table-striped"}
420
+
421
+
422
+ ### Return type
423
+
424
+ [**PromptEntityListing**](PromptEntityListing.html)
425
+
426
+ ### HTTP request headers
427
+
428
+ - **Content-Type**: application/json
429
+ - **Accept**: application/json
430
+
431
+
432
+
433
+ <a name="get_prompts_prompt_id"></a>
434
+
435
+ ## -[**Prompt**](Prompt.html) get_prompts_prompt_id(prompt_id)
436
+
437
+ Get specified user prompt
438
+
439
+
440
+
441
+ Wraps GET /api/v2/architect/prompts/{promptId}
442
+
443
+
444
+ ### Example
445
+ ~~~ruby
446
+ # load the gem
447
+ require 'purecloud'
448
+ # setup authorization
449
+ @secret = ENV['PURECLOUD_SECRET']
450
+ @id = ENV['PURECLOUD_CLIENT_ID']
451
+ environment = "mypurecloud.com"
452
+
453
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
454
+
455
+ PureCloud.configure do |config|
456
+ config.access_token = @authToken
457
+ end
458
+
459
+ api_instance = PureCloud::ArchitectApi.new
460
+
461
+ prompt_id = "prompt_id_example" # String | Prompt ID
462
+
463
+
464
+ begin
465
+ #Get specified user prompt
466
+ result = api_instance.get_prompts_prompt_id(prompt_id)
467
+ p result
468
+ rescue PureCloud::ApiError => e
469
+ puts "Exception when calling ArchitectApi->get_prompts_prompt_id: #{e}"
470
+ end
471
+ ~~~
472
+
473
+ ### Parameters
474
+
475
+ Name | Type | Description | Notes
476
+ ------------- | ------------- | ------------- | -------------
477
+ **prompt_id** | **String**| Prompt ID |
478
+ {: class="table table-striped"}
479
+
480
+
481
+ ### Return type
482
+
483
+ [**Prompt**](Prompt.html)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: application/json
488
+ - **Accept**: application/json
489
+
490
+
491
+
492
+ <a name="get_prompts_prompt_id_resources"></a>
493
+
494
+ ## -[**PromptAssetEntityListing**](PromptAssetEntityListing.html) get_prompts_prompt_id_resources(prompt_id, opts)
495
+
496
+ Get a pageable list of user prompt resources
497
+
498
+ The returned list is pageable, and query parameters can be used for filtering.
499
+
500
+ Wraps GET /api/v2/architect/prompts/{promptId}/resources
501
+
502
+
503
+ ### Example
504
+ ~~~ruby
505
+ # load the gem
506
+ require 'purecloud'
507
+ # setup authorization
508
+ @secret = ENV['PURECLOUD_SECRET']
509
+ @id = ENV['PURECLOUD_CLIENT_ID']
510
+ environment = "mypurecloud.com"
511
+
512
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
513
+
514
+ PureCloud.configure do |config|
515
+ config.access_token = @authToken
516
+ end
517
+
518
+ api_instance = PureCloud::ArchitectApi.new
519
+
520
+ prompt_id = "prompt_id_example" # String | Prompt ID
521
+
522
+ opts = {
523
+ page_number: 1, # Integer | Page number
524
+ page_size: 25 # Integer | Page size
525
+ }
526
+
527
+ begin
528
+ #Get a pageable list of user prompt resources
529
+ result = api_instance.get_prompts_prompt_id_resources(prompt_id, opts)
530
+ p result
531
+ rescue PureCloud::ApiError => e
532
+ puts "Exception when calling ArchitectApi->get_prompts_prompt_id_resources: #{e}"
533
+ end
534
+ ~~~
535
+
536
+ ### Parameters
537
+
538
+ Name | Type | Description | Notes
539
+ ------------- | ------------- | ------------- | -------------
540
+ **prompt_id** | **String**| Prompt ID |
541
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
542
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
543
+ {: class="table table-striped"}
544
+
545
+
546
+ ### Return type
547
+
548
+ [**PromptAssetEntityListing**](PromptAssetEntityListing.html)
549
+
550
+ ### HTTP request headers
551
+
552
+ - **Content-Type**: application/json
553
+ - **Accept**: application/json
554
+
555
+
556
+
557
+ <a name="get_prompts_prompt_id_resources_languagecode"></a>
558
+
559
+ ## -[**PromptAsset**](PromptAsset.html) get_prompts_prompt_id_resources_languagecode(prompt_id, language_code)
560
+
561
+ Get specified user prompt resource
562
+
563
+
564
+
565
+ Wraps GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}
566
+
567
+
568
+ ### Example
569
+ ~~~ruby
570
+ # load the gem
571
+ require 'purecloud'
572
+ # setup authorization
573
+ @secret = ENV['PURECLOUD_SECRET']
574
+ @id = ENV['PURECLOUD_CLIENT_ID']
575
+ environment = "mypurecloud.com"
576
+
577
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
578
+
579
+ PureCloud.configure do |config|
580
+ config.access_token = @authToken
581
+ end
582
+
583
+ api_instance = PureCloud::ArchitectApi.new
584
+
585
+ prompt_id = "prompt_id_example" # String | Prompt ID
586
+
587
+ language_code = "language_code_example" # String | Language
588
+
589
+
590
+ begin
591
+ #Get specified user prompt resource
592
+ result = api_instance.get_prompts_prompt_id_resources_languagecode(prompt_id, language_code)
593
+ p result
594
+ rescue PureCloud::ApiError => e
595
+ puts "Exception when calling ArchitectApi->get_prompts_prompt_id_resources_languagecode: #{e}"
596
+ end
597
+ ~~~
598
+
599
+ ### Parameters
600
+
601
+ Name | Type | Description | Notes
602
+ ------------- | ------------- | ------------- | -------------
603
+ **prompt_id** | **String**| Prompt ID |
604
+ **language_code** | **String**| Language |
605
+ {: class="table table-striped"}
606
+
607
+
608
+ ### Return type
609
+
610
+ [**PromptAsset**](PromptAsset.html)
611
+
612
+ ### HTTP request headers
613
+
614
+ - **Content-Type**: application/json
615
+ - **Accept**: application/json
616
+
617
+
618
+
619
+ <a name="get_systemprompts"></a>
620
+
621
+ ## -[**SystemPromptEntityListing**](SystemPromptEntityListing.html) get_systemprompts(opts)
622
+
623
+ Get System Prompts
624
+
625
+
626
+
627
+ Wraps GET /api/v2/architect/systemprompts
628
+
629
+
630
+ ### Example
631
+ ~~~ruby
632
+ # load the gem
633
+ require 'purecloud'
634
+ # setup authorization
635
+ @secret = ENV['PURECLOUD_SECRET']
636
+ @id = ENV['PURECLOUD_CLIENT_ID']
637
+ environment = "mypurecloud.com"
638
+
639
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
640
+
641
+ PureCloud.configure do |config|
642
+ config.access_token = @authToken
643
+ end
644
+
645
+ api_instance = PureCloud::ArchitectApi.new
646
+
647
+ opts = {
648
+ page_number: 1, # Integer | Page number
649
+ page_size: 25, # Integer | Page size
650
+ sort_by: "id", # String | Sort by
651
+ sort_order: "asc", # String | Sort order
652
+ name: "name_example", # String | Name
653
+ description: "description_example", # String | Description
654
+ name_or_description: "name_or_description_example" # String | Name or description
655
+ }
656
+
657
+ begin
658
+ #Get System Prompts
659
+ result = api_instance.get_systemprompts(opts)
660
+ p result
661
+ rescue PureCloud::ApiError => e
662
+ puts "Exception when calling ArchitectApi->get_systemprompts: #{e}"
663
+ end
664
+ ~~~
665
+
666
+ ### Parameters
667
+
668
+ Name | Type | Description | Notes
669
+ ------------- | ------------- | ------------- | -------------
670
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
671
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
672
+ **sort_by** | **String**| Sort by | [optional] [default to id]
673
+ **sort_order** | **String**| Sort order | [optional] [default to asc]
674
+ **name** | **String**| Name | [optional]
675
+ **description** | **String**| Description | [optional]
676
+ **name_or_description** | **String**| Name or description | [optional]
677
+ {: class="table table-striped"}
678
+
679
+
680
+ ### Return type
681
+
682
+ [**SystemPromptEntityListing**](SystemPromptEntityListing.html)
683
+
684
+ ### HTTP request headers
685
+
686
+ - **Content-Type**: application/json
687
+ - **Accept**: application/json
688
+
689
+
690
+
691
+ <a name="get_systemprompts_prompt_id"></a>
692
+
693
+ ## -[**SystemPrompt**](SystemPrompt.html) get_systemprompts_prompt_id(prompt_id)
694
+
695
+ Get a system prompt
696
+
697
+
698
+
699
+ Wraps GET /api/v2/architect/systemprompts/{promptId}
700
+
701
+
702
+ ### Example
703
+ ~~~ruby
704
+ # load the gem
705
+ require 'purecloud'
706
+ # setup authorization
707
+ @secret = ENV['PURECLOUD_SECRET']
708
+ @id = ENV['PURECLOUD_CLIENT_ID']
709
+ environment = "mypurecloud.com"
710
+
711
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
712
+
713
+ PureCloud.configure do |config|
714
+ config.access_token = @authToken
715
+ end
716
+
717
+ api_instance = PureCloud::ArchitectApi.new
718
+
719
+ prompt_id = "prompt_id_example" # String | promptId
720
+
721
+
722
+ begin
723
+ #Get a system prompt
724
+ result = api_instance.get_systemprompts_prompt_id(prompt_id)
725
+ p result
726
+ rescue PureCloud::ApiError => e
727
+ puts "Exception when calling ArchitectApi->get_systemprompts_prompt_id: #{e}"
728
+ end
729
+ ~~~
730
+
731
+ ### Parameters
732
+
733
+ Name | Type | Description | Notes
734
+ ------------- | ------------- | ------------- | -------------
735
+ **prompt_id** | **String**| promptId |
736
+ {: class="table table-striped"}
737
+
738
+
739
+ ### Return type
740
+
741
+ [**SystemPrompt**](SystemPrompt.html)
742
+
743
+ ### HTTP request headers
744
+
745
+ - **Content-Type**: application/json
746
+ - **Accept**: application/json
747
+
748
+
749
+
750
+ <a name="get_systemprompts_prompt_id_resources"></a>
751
+
752
+ ## -[**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html) get_systemprompts_prompt_id_resources(prompt_id, opts)
753
+
754
+ Get IVR System Prompt resources.
755
+
756
+
757
+
758
+ Wraps GET /api/v2/architect/systemprompts/{promptId}/resources
759
+
760
+
761
+ ### Example
762
+ ~~~ruby
763
+ # load the gem
764
+ require 'purecloud'
765
+ # setup authorization
766
+ @secret = ENV['PURECLOUD_SECRET']
767
+ @id = ENV['PURECLOUD_CLIENT_ID']
768
+ environment = "mypurecloud.com"
769
+
770
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
771
+
772
+ PureCloud.configure do |config|
773
+ config.access_token = @authToken
774
+ end
775
+
776
+ api_instance = PureCloud::ArchitectApi.new
777
+
778
+ prompt_id = "prompt_id_example" # String | Prompt ID
779
+
780
+ opts = {
781
+ page_number: 1, # Integer | Page number
782
+ page_size: 25, # Integer | Page size
783
+ sort_by: "id", # String | Sort by
784
+ sort_order: "asc" # String | Sort order
785
+ }
786
+
787
+ begin
788
+ #Get IVR System Prompt resources.
789
+ result = api_instance.get_systemprompts_prompt_id_resources(prompt_id, opts)
790
+ p result
791
+ rescue PureCloud::ApiError => e
792
+ puts "Exception when calling ArchitectApi->get_systemprompts_prompt_id_resources: #{e}"
793
+ end
794
+ ~~~
795
+
796
+ ### Parameters
797
+
798
+ Name | Type | Description | Notes
799
+ ------------- | ------------- | ------------- | -------------
800
+ **prompt_id** | **String**| Prompt ID |
801
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
802
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
803
+ **sort_by** | **String**| Sort by | [optional] [default to id]
804
+ **sort_order** | **String**| Sort order | [optional] [default to asc]
805
+ {: class="table table-striped"}
806
+
807
+
808
+ ### Return type
809
+
810
+ [**SystemPromptAssetEntityListing**](SystemPromptAssetEntityListing.html)
811
+
812
+ ### HTTP request headers
813
+
814
+ - **Content-Type**: application/json
815
+ - **Accept**: application/json
816
+
817
+
818
+
819
+ <a name="get_systemprompts_prompt_id_resources_languagecode"></a>
820
+
821
+ ## -[**SystemPromptAsset**](SystemPromptAsset.html) get_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code)
822
+
823
+ Get a system prompt resource.
824
+
825
+
826
+
827
+ Wraps GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
828
+
829
+
830
+ ### Example
831
+ ~~~ruby
832
+ # load the gem
833
+ require 'purecloud'
834
+ # setup authorization
835
+ @secret = ENV['PURECLOUD_SECRET']
836
+ @id = ENV['PURECLOUD_CLIENT_ID']
837
+ environment = "mypurecloud.com"
838
+
839
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
840
+
841
+ PureCloud.configure do |config|
842
+ config.access_token = @authToken
843
+ end
844
+
845
+ api_instance = PureCloud::ArchitectApi.new
846
+
847
+ prompt_id = "prompt_id_example" # String | Prompt ID
848
+
849
+ language_code = "language_code_example" # String | Language
850
+
851
+
852
+ begin
853
+ #Get a system prompt resource.
854
+ result = api_instance.get_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code)
855
+ p result
856
+ rescue PureCloud::ApiError => e
857
+ puts "Exception when calling ArchitectApi->get_systemprompts_prompt_id_resources_languagecode: #{e}"
858
+ end
859
+ ~~~
860
+
861
+ ### Parameters
862
+
863
+ Name | Type | Description | Notes
864
+ ------------- | ------------- | ------------- | -------------
865
+ **prompt_id** | **String**| Prompt ID |
866
+ **language_code** | **String**| Language |
867
+ {: class="table table-striped"}
868
+
869
+
870
+ ### Return type
871
+
872
+ [**SystemPromptAsset**](SystemPromptAsset.html)
873
+
874
+ ### HTTP request headers
875
+
876
+ - **Content-Type**: application/json
877
+ - **Accept**: application/json
878
+
879
+
880
+
881
+ <a name="post_prompts"></a>
882
+
883
+ ## -[**Prompt**](Prompt.html) post_prompts(opts)
884
+
885
+ Create a new user prompt
886
+
887
+
888
+
889
+ Wraps POST /api/v2/architect/prompts
890
+
891
+
892
+ ### Example
893
+ ~~~ruby
894
+ # load the gem
895
+ require 'purecloud'
896
+ # setup authorization
897
+ @secret = ENV['PURECLOUD_SECRET']
898
+ @id = ENV['PURECLOUD_CLIENT_ID']
899
+ environment = "mypurecloud.com"
900
+
901
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
902
+
903
+ PureCloud.configure do |config|
904
+ config.access_token = @authToken
905
+ end
906
+
907
+ api_instance = PureCloud::ArchitectApi.new
908
+
909
+ opts = {
910
+ body: PureCloud::Prompt.new # Prompt |
911
+ }
912
+
913
+ begin
914
+ #Create a new user prompt
915
+ result = api_instance.post_prompts(opts)
916
+ p result
917
+ rescue PureCloud::ApiError => e
918
+ puts "Exception when calling ArchitectApi->post_prompts: #{e}"
919
+ end
920
+ ~~~
921
+
922
+ ### Parameters
923
+
924
+ Name | Type | Description | Notes
925
+ ------------- | ------------- | ------------- | -------------
926
+ **body** | [**Prompt**](Prompt.html)| | [optional]
927
+ {: class="table table-striped"}
928
+
929
+
930
+ ### Return type
931
+
932
+ [**Prompt**](Prompt.html)
933
+
934
+ ### HTTP request headers
935
+
936
+ - **Content-Type**: application/json
937
+ - **Accept**: application/json
938
+
939
+
940
+
941
+ <a name="post_prompts_prompt_id_resources"></a>
942
+
943
+ ## -[**PromptAsset**](PromptAsset.html) post_prompts_prompt_id_resources(prompt_id, opts)
944
+
945
+ Create a new user prompt resource
946
+
947
+
948
+
949
+ Wraps POST /api/v2/architect/prompts/{promptId}/resources
950
+
951
+
952
+ ### Example
953
+ ~~~ruby
954
+ # load the gem
955
+ require 'purecloud'
956
+ # setup authorization
957
+ @secret = ENV['PURECLOUD_SECRET']
958
+ @id = ENV['PURECLOUD_CLIENT_ID']
959
+ environment = "mypurecloud.com"
960
+
961
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
962
+
963
+ PureCloud.configure do |config|
964
+ config.access_token = @authToken
965
+ end
966
+
967
+ api_instance = PureCloud::ArchitectApi.new
968
+
969
+ prompt_id = "prompt_id_example" # String | Prompt ID
970
+
971
+ opts = {
972
+ body: PureCloud::PromptAssetCreate.new # PromptAssetCreate |
973
+ }
974
+
975
+ begin
976
+ #Create a new user prompt resource
977
+ result = api_instance.post_prompts_prompt_id_resources(prompt_id, opts)
978
+ p result
979
+ rescue PureCloud::ApiError => e
980
+ puts "Exception when calling ArchitectApi->post_prompts_prompt_id_resources: #{e}"
981
+ end
982
+ ~~~
983
+
984
+ ### Parameters
985
+
986
+ Name | Type | Description | Notes
987
+ ------------- | ------------- | ------------- | -------------
988
+ **prompt_id** | **String**| Prompt ID |
989
+ **body** | [**PromptAssetCreate**](PromptAssetCreate.html)| | [optional]
990
+ {: class="table table-striped"}
991
+
992
+
993
+ ### Return type
994
+
995
+ [**PromptAsset**](PromptAsset.html)
996
+
997
+ ### HTTP request headers
998
+
999
+ - **Content-Type**: application/json
1000
+ - **Accept**: application/json
1001
+
1002
+
1003
+
1004
+ <a name="post_systemprompts_prompt_id_resources"></a>
1005
+
1006
+ ## -[**SystemPromptAsset**](SystemPromptAsset.html) post_systemprompts_prompt_id_resources(prompt_id, opts)
1007
+
1008
+ Create system prompt resource override.
1009
+
1010
+
1011
+
1012
+ Wraps POST /api/v2/architect/systemprompts/{promptId}/resources
1013
+
1014
+
1015
+ ### Example
1016
+ ~~~ruby
1017
+ # load the gem
1018
+ require 'purecloud'
1019
+ # setup authorization
1020
+ @secret = ENV['PURECLOUD_SECRET']
1021
+ @id = ENV['PURECLOUD_CLIENT_ID']
1022
+ environment = "mypurecloud.com"
1023
+
1024
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1025
+
1026
+ PureCloud.configure do |config|
1027
+ config.access_token = @authToken
1028
+ end
1029
+
1030
+ api_instance = PureCloud::ArchitectApi.new
1031
+
1032
+ prompt_id = "prompt_id_example" # String | Prompt ID
1033
+
1034
+ opts = {
1035
+ body: PureCloud::SystemPromptAsset.new # SystemPromptAsset |
1036
+ }
1037
+
1038
+ begin
1039
+ #Create system prompt resource override.
1040
+ result = api_instance.post_systemprompts_prompt_id_resources(prompt_id, opts)
1041
+ p result
1042
+ rescue PureCloud::ApiError => e
1043
+ puts "Exception when calling ArchitectApi->post_systemprompts_prompt_id_resources: #{e}"
1044
+ end
1045
+ ~~~
1046
+
1047
+ ### Parameters
1048
+
1049
+ Name | Type | Description | Notes
1050
+ ------------- | ------------- | ------------- | -------------
1051
+ **prompt_id** | **String**| Prompt ID |
1052
+ **body** | [**SystemPromptAsset**](SystemPromptAsset.html)| | [optional]
1053
+ {: class="table table-striped"}
1054
+
1055
+
1056
+ ### Return type
1057
+
1058
+ [**SystemPromptAsset**](SystemPromptAsset.html)
1059
+
1060
+ ### HTTP request headers
1061
+
1062
+ - **Content-Type**: application/json
1063
+ - **Accept**: application/json
1064
+
1065
+
1066
+
1067
+ <a name="put_prompts_prompt_id"></a>
1068
+
1069
+ ## -[**Prompt**](Prompt.html) put_prompts_prompt_id(prompt_id, opts)
1070
+
1071
+ Update specified user prompt
1072
+
1073
+
1074
+
1075
+ Wraps PUT /api/v2/architect/prompts/{promptId}
1076
+
1077
+
1078
+ ### Example
1079
+ ~~~ruby
1080
+ # load the gem
1081
+ require 'purecloud'
1082
+ # setup authorization
1083
+ @secret = ENV['PURECLOUD_SECRET']
1084
+ @id = ENV['PURECLOUD_CLIENT_ID']
1085
+ environment = "mypurecloud.com"
1086
+
1087
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1088
+
1089
+ PureCloud.configure do |config|
1090
+ config.access_token = @authToken
1091
+ end
1092
+
1093
+ api_instance = PureCloud::ArchitectApi.new
1094
+
1095
+ prompt_id = "prompt_id_example" # String | Prompt ID
1096
+
1097
+ opts = {
1098
+ body: PureCloud::Prompt.new # Prompt |
1099
+ }
1100
+
1101
+ begin
1102
+ #Update specified user prompt
1103
+ result = api_instance.put_prompts_prompt_id(prompt_id, opts)
1104
+ p result
1105
+ rescue PureCloud::ApiError => e
1106
+ puts "Exception when calling ArchitectApi->put_prompts_prompt_id: #{e}"
1107
+ end
1108
+ ~~~
1109
+
1110
+ ### Parameters
1111
+
1112
+ Name | Type | Description | Notes
1113
+ ------------- | ------------- | ------------- | -------------
1114
+ **prompt_id** | **String**| Prompt ID |
1115
+ **body** | [**Prompt**](Prompt.html)| | [optional]
1116
+ {: class="table table-striped"}
1117
+
1118
+
1119
+ ### Return type
1120
+
1121
+ [**Prompt**](Prompt.html)
1122
+
1123
+ ### HTTP request headers
1124
+
1125
+ - **Content-Type**: application/json
1126
+ - **Accept**: application/json
1127
+
1128
+
1129
+
1130
+ <a name="put_prompts_prompt_id_resources_languagecode"></a>
1131
+
1132
+ ## -[**PromptAsset**](PromptAsset.html) put_prompts_prompt_id_resources_languagecode(prompt_id, language_code, opts)
1133
+
1134
+ Update specified user prompt resource
1135
+
1136
+
1137
+
1138
+ Wraps PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}
1139
+
1140
+
1141
+ ### Example
1142
+ ~~~ruby
1143
+ # load the gem
1144
+ require 'purecloud'
1145
+ # setup authorization
1146
+ @secret = ENV['PURECLOUD_SECRET']
1147
+ @id = ENV['PURECLOUD_CLIENT_ID']
1148
+ environment = "mypurecloud.com"
1149
+
1150
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1151
+
1152
+ PureCloud.configure do |config|
1153
+ config.access_token = @authToken
1154
+ end
1155
+
1156
+ api_instance = PureCloud::ArchitectApi.new
1157
+
1158
+ prompt_id = "prompt_id_example" # String | Prompt ID
1159
+
1160
+ language_code = "language_code_example" # String | Language
1161
+
1162
+ opts = {
1163
+ body: PureCloud::PromptAsset.new # PromptAsset |
1164
+ }
1165
+
1166
+ begin
1167
+ #Update specified user prompt resource
1168
+ result = api_instance.put_prompts_prompt_id_resources_languagecode(prompt_id, language_code, opts)
1169
+ p result
1170
+ rescue PureCloud::ApiError => e
1171
+ puts "Exception when calling ArchitectApi->put_prompts_prompt_id_resources_languagecode: #{e}"
1172
+ end
1173
+ ~~~
1174
+
1175
+ ### Parameters
1176
+
1177
+ Name | Type | Description | Notes
1178
+ ------------- | ------------- | ------------- | -------------
1179
+ **prompt_id** | **String**| Prompt ID |
1180
+ **language_code** | **String**| Language |
1181
+ **body** | [**PromptAsset**](PromptAsset.html)| | [optional]
1182
+ {: class="table table-striped"}
1183
+
1184
+
1185
+ ### Return type
1186
+
1187
+ [**PromptAsset**](PromptAsset.html)
1188
+
1189
+ ### HTTP request headers
1190
+
1191
+ - **Content-Type**: application/json
1192
+ - **Accept**: application/json
1193
+
1194
+
1195
+
1196
+ <a name="put_systemprompts_prompt_id_resources_languagecode"></a>
1197
+
1198
+ ## -[**SystemPromptAsset**](SystemPromptAsset.html) put_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts)
1199
+
1200
+ Updates a system prompt resource override.
1201
+
1202
+
1203
+
1204
+ Wraps PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
1205
+
1206
+
1207
+ ### Example
1208
+ ~~~ruby
1209
+ # load the gem
1210
+ require 'purecloud'
1211
+ # setup authorization
1212
+ @secret = ENV['PURECLOUD_SECRET']
1213
+ @id = ENV['PURECLOUD_CLIENT_ID']
1214
+ environment = "mypurecloud.com"
1215
+
1216
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1217
+
1218
+ PureCloud.configure do |config|
1219
+ config.access_token = @authToken
1220
+ end
1221
+
1222
+ api_instance = PureCloud::ArchitectApi.new
1223
+
1224
+ prompt_id = "prompt_id_example" # String | Prompt ID
1225
+
1226
+ language_code = "language_code_example" # String | Language
1227
+
1228
+ opts = {
1229
+ body: PureCloud::SystemPromptAsset.new # SystemPromptAsset |
1230
+ }
1231
+
1232
+ begin
1233
+ #Updates a system prompt resource override.
1234
+ result = api_instance.put_systemprompts_prompt_id_resources_languagecode(prompt_id, language_code, opts)
1235
+ p result
1236
+ rescue PureCloud::ApiError => e
1237
+ puts "Exception when calling ArchitectApi->put_systemprompts_prompt_id_resources_languagecode: #{e}"
1238
+ end
1239
+ ~~~
1240
+
1241
+ ### Parameters
1242
+
1243
+ Name | Type | Description | Notes
1244
+ ------------- | ------------- | ------------- | -------------
1245
+ **prompt_id** | **String**| Prompt ID |
1246
+ **language_code** | **String**| Language |
1247
+ **body** | [**SystemPromptAsset**](SystemPromptAsset.html)| | [optional]
1248
+ {: class="table table-striped"}
1249
+
1250
+
1251
+ ### Return type
1252
+
1253
+ [**SystemPromptAsset**](SystemPromptAsset.html)
1254
+
1255
+ ### HTTP request headers
1256
+
1257
+ - **Content-Type**: application/json
1258
+ - **Accept**: application/json
1259
+
1260
+
1261
+