purecloud 0.28.0 → 0.29.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (294) hide show
  1. checksums.yaml +4 -4
  2. data/config-ruby.json +1 -1
  3. data/lib/purecloud.rb +119 -110
  4. data/lib/purecloud/api/alerting_api.rb +609 -0
  5. data/lib/purecloud/api/analytics_api.rb +0 -618
  6. data/lib/purecloud/api/authorization_api.rb +32 -26
  7. data/lib/purecloud/api/callbacks_api.rb +5 -5
  8. data/lib/purecloud/api/calls_api.rb +5 -5
  9. data/lib/purecloud/api/chats_api.rb +5 -5
  10. data/lib/purecloud/api/configuration_api.rb +325 -4514
  11. data/lib/purecloud/api/conversations_api.rb +30 -157
  12. data/lib/purecloud/api/emails_api.rb +5 -5
  13. data/lib/purecloud/api/groups_api.rb +120 -0
  14. data/lib/purecloud/api/integrations_api.rb +6 -0
  15. data/lib/purecloud/api/integrations_workforce_management_api.rb +73 -0
  16. data/lib/purecloud/api/languages_api.rb +181 -0
  17. data/lib/purecloud/api/organization_api.rb +243 -0
  18. data/lib/purecloud/api/outbound_api.rb +13 -380
  19. data/lib/purecloud/api/presence_api.rb +20 -222
  20. data/lib/purecloud/api/quality_api.rb +30 -0
  21. data/lib/purecloud/api/recording_api.rb +12 -0
  22. data/lib/purecloud/api/routing_api.rb +211 -8
  23. data/lib/purecloud/api/scripts_api.rb +8 -2
  24. data/lib/purecloud/api/search_api.rb +315 -13
  25. data/lib/purecloud/api/socials_api.rb +5 -5
  26. data/lib/purecloud/api/telephony_providers_edge_api.rb +4594 -698
  27. data/lib/purecloud/api/users_api.rb +303 -44
  28. data/lib/purecloud/api/utilities_api.rb +0 -58
  29. data/lib/purecloud/api/videos_api.rb +5 -5
  30. data/lib/purecloud/models/address.rb +49 -51
  31. data/lib/purecloud/models/address_listing.rb +12 -12
  32. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  33. data/lib/purecloud/models/{analytics_segment.rb → analytics_conversation_segment.rb} +8 -8
  34. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  35. data/lib/purecloud/models/analytics_session.rb +1 -1
  36. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  37. data/lib/purecloud/models/{primary_user_presence_source.rb → audit_entity.rb} +12 -24
  38. data/lib/purecloud/models/{facet.rb → audit_facet.rb} +1 -1
  39. data/lib/purecloud/models/audit_filter.rb +178 -0
  40. data/lib/purecloud/models/audit_message.rb +2 -2
  41. data/lib/purecloud/models/{facet_group.rb → audit_user.rb} +18 -20
  42. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +11 -11
  43. data/lib/purecloud/models/available_additional_service_listing.rb +11 -11
  44. data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
  45. data/lib/purecloud/models/{chat_search_item.rb → billing_address.rb} +37 -27
  46. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  47. data/lib/purecloud/models/call.rb +16 -4
  48. data/lib/purecloud/models/call_conversation.rb +1 -1
  49. data/lib/purecloud/models/{chat_search_listing.rb → call_conversation_entity_listing.rb} +13 -13
  50. data/lib/purecloud/models/{call_participant.rb → call_media_participant.rb} +1 -1
  51. data/lib/purecloud/models/callable_time.rb +1 -1
  52. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  53. data/lib/purecloud/models/callback_conversation.rb +1 -1
  54. data/lib/purecloud/models/callback_conversation_entity_listing.rb +238 -0
  55. data/lib/purecloud/models/{callback_participant.rb → callback_media_participant.rb} +1 -1
  56. data/lib/purecloud/models/campaign.rb +219 -17
  57. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  58. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  59. data/lib/purecloud/models/{facet_item.rb → campaign_time_slot.rb} +20 -20
  60. data/lib/purecloud/models/carrier_entity_listing.rb +11 -11
  61. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  62. data/lib/purecloud/models/change.rb +1 -1
  63. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  64. data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
  65. data/lib/purecloud/models/chat_conversation.rb +1 -1
  66. data/lib/purecloud/models/{rule_entity_listing.rb → chat_conversation_entity_listing.rb} +13 -13
  67. data/lib/purecloud/models/{chat_participant.rb → chat_media_participant.rb} +1 -1
  68. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  69. data/lib/purecloud/models/common_audit_request.rb +2 -2
  70. data/lib/purecloud/models/{template.rb → composer_template.rb} +2 -2
  71. data/lib/purecloud/models/consumed_resources_entity_listing.rb +11 -11
  72. data/lib/purecloud/models/consuming_resources_entity_listing.rb +11 -11
  73. data/lib/purecloud/models/{client_transform_model.rb → contact_address.rb} +42 -36
  74. data/lib/purecloud/models/contact_list.rb +111 -1
  75. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  76. data/lib/purecloud/models/contact_listing.rb +11 -11
  77. data/lib/purecloud/models/{dialer_disposition_call_command.rb → contact_phone_number_column.rb} +20 -20
  78. data/lib/purecloud/models/{facet_filter_item.rb → content_filter_item.rb} +1 -1
  79. data/lib/purecloud/models/{transform_progress.rb → conversation_chat.rb} +91 -82
  80. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  81. data/lib/purecloud/models/create_share_request.rb +2 -2
  82. data/lib/purecloud/models/create_share_request_member.rb +1 -1
  83. data/lib/purecloud/models/customer_account.rb +1 -1
  84. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +11 -11
  85. data/lib/purecloud/models/dependency_object_entity_listing.rb +11 -11
  86. data/lib/purecloud/models/dependency_type_entity_listing.rb +11 -11
  87. data/lib/purecloud/models/{action.rb → dialer_action.rb} +1 -1
  88. data/lib/purecloud/models/dialer_audit_request.rb +2 -2
  89. data/lib/purecloud/models/{transform_model.rb → dialer_contact.rb} +42 -28
  90. data/lib/purecloud/models/{rule.rb → dialer_rule.rb} +2 -2
  91. data/lib/purecloud/models/did.rb +1 -1
  92. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  93. data/lib/purecloud/models/did_pool.rb +1 -1
  94. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  95. data/lib/purecloud/models/{metric_threshold.rb → disconnect_reason.rb} +29 -19
  96. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  97. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  98. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  99. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +11 -11
  100. data/lib/purecloud/models/domain_certificate_authority.rb +1 -1
  101. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  102. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  103. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  104. data/lib/purecloud/models/domain_invoice_entity_listing.rb +11 -11
  105. data/lib/purecloud/models/domain_logical_interface.rb +28 -2
  106. data/lib/purecloud/models/{dialer_place_call_command.rb → domain_role.rb} +16 -14
  107. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +11 -11
  108. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +11 -11
  109. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +11 -11
  110. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +11 -11
  111. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +11 -11
  112. data/lib/purecloud/models/edge.rb +1 -1
  113. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  114. data/lib/purecloud/models/edge_group.rb +1 -1
  115. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  116. data/lib/purecloud/models/edge_line.rb +1 -1
  117. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  118. data/lib/purecloud/models/email_conversation.rb +1 -1
  119. data/lib/purecloud/models/{user_presence_entity_listing.rb → email_conversation_entity_listing.rb} +13 -13
  120. data/lib/purecloud/models/{email_participant.rb → email_media_participant.rb} +1 -1
  121. data/lib/purecloud/models/email_message.rb +56 -26
  122. data/lib/purecloud/models/email_message_listing.rb +11 -11
  123. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  124. data/lib/purecloud/models/endpoint.rb +2 -2
  125. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  126. data/lib/purecloud/models/entity.rb +20 -10
  127. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  128. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  129. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  130. data/lib/purecloud/models/extension.rb +1 -1
  131. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  132. data/lib/purecloud/models/extension_pool.rb +1 -1
  133. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  134. data/lib/purecloud/models/external_contact.rb +1 -1
  135. data/lib/purecloud/models/external_organization.rb +1 -1
  136. data/lib/purecloud/models/external_organization_listing.rb +11 -11
  137. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  138. data/lib/purecloud/models/flow_body.rb +1 -1
  139. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +11 -11
  140. data/lib/purecloud/models/flow_entity_listing.rb +11 -11
  141. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +11 -11
  142. data/lib/purecloud/models/flow_search_request.rb +222 -0
  143. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +11 -11
  144. data/lib/purecloud/models/flow_version_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/group.rb +42 -36
  146. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/groups_search_response.rb +230 -0
  148. data/lib/purecloud/models/hardware_rate_listing.rb +11 -11
  149. data/lib/purecloud/models/health_check_info.rb +1 -31
  150. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/integration_type_entity_listing.rb +11 -11
  153. data/lib/purecloud/models/interaction_stats_alert.rb +373 -0
  154. data/lib/purecloud/models/interaction_stats_alert_container.rb +238 -0
  155. data/lib/purecloud/models/{alert.rb → interaction_stats_rule.rb} +111 -80
  156. data/lib/purecloud/models/interaction_stats_rule_container.rb +238 -0
  157. data/lib/purecloud/models/ivr.rb +1 -1
  158. data/lib/purecloud/models/ivr_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/json_node.rb +395 -0
  160. data/lib/purecloud/models/json_node_search_response.rb +228 -0
  161. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  162. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  163. data/lib/purecloud/models/line.rb +2 -2
  164. data/lib/purecloud/models/line_base.rb +1 -1
  165. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  166. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  167. data/lib/purecloud/models/{body_1.rb → line_properties.rb} +1 -1
  168. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +11 -11
  169. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +11 -11
  170. data/lib/purecloud/models/location_entity_listing.rb +11 -11
  171. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  172. data/lib/purecloud/models/media_participant_request.rb +232 -0
  173. data/lib/purecloud/models/{inline_response_200.rb → member_entity.rb} +13 -3
  174. data/lib/purecloud/models/note_listing.rb +11 -11
  175. data/lib/purecloud/models/number_plan.rb +1 -1
  176. data/lib/purecloud/models/o_auth_client.rb +1 -1
  177. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  178. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/organization.rb +2 -22
  180. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  182. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  183. data/lib/purecloud/models/outbound_route.rb +1 -1
  184. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  185. data/lib/purecloud/models/page.rb +2 -2
  186. data/lib/purecloud/models/participant.rb +1 -1
  187. data/lib/purecloud/models/participant_request.rb +7 -0
  188. data/lib/purecloud/models/payment_method_listing.rb +11 -11
  189. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  190. data/lib/purecloud/models/phone.rb +2 -2
  191. data/lib/purecloud/models/phone_base.rb +1 -1
  192. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  193. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  194. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  196. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  197. data/lib/purecloud/models/prompt_asset.rb +25 -1
  198. data/lib/purecloud/models/prompt_asset_entity_listing.rb +11 -11
  199. data/lib/purecloud/models/prompt_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  201. data/lib/purecloud/models/query_request.rb +1 -1
  202. data/lib/purecloud/models/queue.rb +1 -1
  203. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  204. data/lib/purecloud/models/queues_entity_listing.rb +11 -11
  205. data/lib/purecloud/models/quote_charge.rb +1 -1
  206. data/lib/purecloud/models/quote_listing.rb +11 -11
  207. data/lib/purecloud/models/recording.rb +13 -2
  208. data/lib/purecloud/models/{preview.rb → recording_email_message.rb} +72 -57
  209. data/lib/purecloud/models/relationship_listing.rb +11 -11
  210. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  211. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  212. data/lib/purecloud/models/report_schedule.rb +1 -1
  213. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/resource_permission_policy.rb +1 -11
  215. data/lib/purecloud/models/response.rb +84 -14
  216. data/lib/purecloud/models/response_entity_list.rb +11 -11
  217. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/{filter.rb → response_filter.rb} +1 -1
  219. data/lib/purecloud/models/response_query_request.rb +1 -1
  220. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/rule_set.rb +1 -1
  222. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/schedule.rb +1 -1
  224. data/lib/purecloud/models/schedule_entity_listing.rb +11 -11
  225. data/lib/purecloud/models/schedule_group.rb +1 -1
  226. data/lib/purecloud/models/schedule_group_entity_listing.rb +11 -11
  227. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  228. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  229. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  230. data/lib/purecloud/models/{occurrence.rb → search_aggregation.rb} +19 -9
  231. data/lib/purecloud/models/{conversation_historical_query_request_filter.rb → search_criteria.rb} +83 -24
  232. data/lib/purecloud/models/search_request.rb +73 -50
  233. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/service_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/{group_images.rb → shared_entity.rb} +8 -10
  237. data/lib/purecloud/models/site.rb +1 -1
  238. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  239. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/social_conversation.rb +1 -1
  241. data/lib/purecloud/models/social_conversation_entity_listing.rb +238 -0
  242. data/lib/purecloud/models/{social_participant.rb → social_media_participant.rb} +1 -1
  243. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/station.rb +11 -1
  245. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/{facets.rb → subscriber_response.rb} +16 -16
  247. data/lib/purecloud/models/system_prompt_asset.rb +25 -1
  248. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +11 -11
  249. data/lib/purecloud/models/system_prompt_entity_listing.rb +11 -11
  250. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  251. data/lib/purecloud/models/template_entity_listing.rb +12 -12
  252. data/lib/purecloud/models/text_table_transform_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/time_slot.rb +3 -0
  254. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  255. data/lib/purecloud/models/trunk_base.rb +2 -2
  256. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  257. data/lib/purecloud/models/unread_metric.rb +1 -0
  258. data/lib/purecloud/models/unread_status.rb +149 -0
  259. data/lib/purecloud/models/user.rb +7 -7
  260. data/lib/purecloud/models/user_action_category_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/user_authorization.rb +7 -37
  263. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  264. data/lib/purecloud/models/user_me.rb +375 -0
  265. data/lib/purecloud/models/user_presence.rb +14 -32
  266. data/lib/purecloud/models/user_queue.rb +1 -1
  267. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  268. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  269. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  270. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  271. data/lib/purecloud/models/users_search_response.rb +230 -0
  272. data/lib/purecloud/models/validate_address_response.rb +1 -1
  273. data/lib/purecloud/models/video_conversation.rb +1 -1
  274. data/lib/purecloud/models/{alert_entity_listing.rb → video_conversation_entity_listing.rb} +13 -13
  275. data/lib/purecloud/models/{video_participant.rb → video_media_participant.rb} +1 -1
  276. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +11 -11
  277. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +11 -11
  278. data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
  279. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  280. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  281. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  282. data/lib/purecloud/version.rb +1 -1
  283. data/newVersion.md +1 -1
  284. data/swagger.json +1 -1
  285. data/version.json +1 -1
  286. metadata +54 -45
  287. data/lib/purecloud/api/architect_api.rb +0 -3285
  288. data/lib/purecloud/models/chat_search_request.rb +0 -244
  289. data/lib/purecloud/models/conversation_historical_query_request_body.rb +0 -185
  290. data/lib/purecloud/models/conversation_query_response.rb +0 -366
  291. data/lib/purecloud/models/dialer_call.rb +0 -156
  292. data/lib/purecloud/models/penetration_rate.rb +0 -176
  293. data/lib/purecloud/models/penetration_rate_id.rb +0 -156
  294. data/lib/purecloud/models/progress_model.rb +0 -169
@@ -1,3285 +0,0 @@
1
- require "uri"
2
-
3
- module PureCloud
4
- class ArchitectApi
5
- attr_accessor :api_client
6
-
7
- def initialize(api_client = ApiClient.default)
8
- @api_client = api_client
9
- end
10
-
11
- # Gets architect-data-service audit entries.
12
- #
13
- # @param [Hash] opts the optional parameters
14
- # @option opts [CommonAuditRequest] :body AuditSearchRequest
15
- # @return [AuditSearchResult]
16
- def post_audits(opts = {})
17
- data, status_code, headers = post_audits_with_http_info(opts)
18
- return data
19
- end
20
-
21
- # Gets architect-data-service audit entries.
22
- #
23
- # @param [Hash] opts the optional parameters
24
- # @option opts [CommonAuditRequest] :body AuditSearchRequest
25
- # @return [Array<(AuditSearchResult, Fixnum, Hash)>] AuditSearchResult data, response status code and response headers
26
- def post_audits_with_http_info(opts = {})
27
- if @api_client.config.debugging
28
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_audits ..."
29
- end
30
-
31
- # resource path
32
- path = "/api/v2/architect/audits".sub('{format}','json')
33
-
34
- # query parameters
35
- query_params = {}
36
-
37
- # header parameters
38
- header_params = {}
39
-
40
- # HTTP header 'Accept' (if needed)
41
- _header_accept = ['application/json']
42
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
43
-
44
- # HTTP header 'Content-Type'
45
- _header_content_type = ['application/json']
46
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
47
-
48
- # form parameters
49
- form_params = {}
50
-
51
- # http body (model)
52
- post_body = @api_client.object_to_http_body(opts[:'body'])
53
-
54
-
55
- auth_names = ['PureCloud Auth']
56
- data, status_code, headers = @api_client.call_api(:POST, path,
57
- :header_params => header_params,
58
- :query_params => query_params,
59
- :form_params => form_params,
60
- :body => post_body,
61
- :auth_names => auth_names,
62
- :return_type => 'AuditSearchResult')
63
- if @api_client.config.debugging
64
- @api_client.config.logger.debug "API called: ArchitectApi#post_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
- end
66
- return data, status_code, headers
67
- end
68
-
69
- # Get IVR configs.
70
- #
71
- # @param [Hash] opts the optional parameters
72
- # @option opts [Integer] :page_number Page number
73
- # @option opts [Integer] :page_size Page size
74
- # @option opts [String] :sort_by Sort by
75
- # @option opts [String] :sort_order Sort order
76
- # @return [IVREntityListing]
77
- def get_ivrs(opts = {})
78
- data, status_code, headers = get_ivrs_with_http_info(opts)
79
- return data
80
- end
81
-
82
- # Get IVR configs.
83
- #
84
- # @param [Hash] opts the optional parameters
85
- # @option opts [Integer] :page_number Page number
86
- # @option opts [Integer] :page_size Page size
87
- # @option opts [String] :sort_by Sort by
88
- # @option opts [String] :sort_order Sort order
89
- # @return [Array<(IVREntityListing, Fixnum, Hash)>] IVREntityListing data, response status code and response headers
90
- def get_ivrs_with_http_info(opts = {})
91
- if @api_client.config.debugging
92
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_ivrs ..."
93
- end
94
-
95
- # resource path
96
- path = "/api/v2/architect/ivrs".sub('{format}','json')
97
-
98
- # query parameters
99
- query_params = {}
100
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
101
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
102
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
103
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
104
-
105
- # header parameters
106
- header_params = {}
107
-
108
- # HTTP header 'Accept' (if needed)
109
- _header_accept = ['application/json']
110
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
111
-
112
- # HTTP header 'Content-Type'
113
- _header_content_type = ['application/json']
114
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
115
-
116
- # form parameters
117
- form_params = {}
118
-
119
- # http body (model)
120
- post_body = nil
121
-
122
-
123
- auth_names = ['PureCloud Auth']
124
- data, status_code, headers = @api_client.call_api(:GET, path,
125
- :header_params => header_params,
126
- :query_params => query_params,
127
- :form_params => form_params,
128
- :body => post_body,
129
- :auth_names => auth_names,
130
- :return_type => 'IVREntityListing')
131
- if @api_client.config.debugging
132
- @api_client.config.logger.debug "API called: ArchitectApi#get_ivrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
133
- end
134
- return data, status_code, headers
135
- end
136
-
137
- # Create IVR config.
138
- #
139
- # @param [Hash] opts the optional parameters
140
- # @option opts [IVR] :body
141
- # @return [IVR]
142
- def post_ivrs(opts = {})
143
- data, status_code, headers = post_ivrs_with_http_info(opts)
144
- return data
145
- end
146
-
147
- # Create IVR config.
148
- #
149
- # @param [Hash] opts the optional parameters
150
- # @option opts [IVR] :body
151
- # @return [Array<(IVR, Fixnum, Hash)>] IVR data, response status code and response headers
152
- def post_ivrs_with_http_info(opts = {})
153
- if @api_client.config.debugging
154
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_ivrs ..."
155
- end
156
-
157
- # resource path
158
- path = "/api/v2/architect/ivrs".sub('{format}','json')
159
-
160
- # query parameters
161
- query_params = {}
162
-
163
- # header parameters
164
- header_params = {}
165
-
166
- # HTTP header 'Accept' (if needed)
167
- _header_accept = ['application/json']
168
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
169
-
170
- # HTTP header 'Content-Type'
171
- _header_content_type = ['application/json']
172
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
173
-
174
- # form parameters
175
- form_params = {}
176
-
177
- # http body (model)
178
- post_body = @api_client.object_to_http_body(opts[:'body'])
179
-
180
-
181
- auth_names = ['PureCloud Auth']
182
- data, status_code, headers = @api_client.call_api(:POST, path,
183
- :header_params => header_params,
184
- :query_params => query_params,
185
- :form_params => form_params,
186
- :body => post_body,
187
- :auth_names => auth_names,
188
- :return_type => 'IVR')
189
- if @api_client.config.debugging
190
- @api_client.config.logger.debug "API called: ArchitectApi#post_ivrs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
191
- end
192
- return data, status_code, headers
193
- end
194
-
195
- # Publish an IVR config.
196
- #
197
- # @param id
198
- # @param [Hash] opts the optional parameters
199
- # @return [IVR]
200
- def post_ivrs_actions_publish(id, opts = {})
201
- data, status_code, headers = post_ivrs_actions_publish_with_http_info(id, opts)
202
- return data
203
- end
204
-
205
- # Publish an IVR config.
206
- #
207
- # @param id
208
- # @param [Hash] opts the optional parameters
209
- # @return [Array<(IVR, Fixnum, Hash)>] IVR data, response status code and response headers
210
- def post_ivrs_actions_publish_with_http_info(id, opts = {})
211
- if @api_client.config.debugging
212
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_ivrs_actions_publish ..."
213
- end
214
-
215
- # verify the required parameter 'id' is set
216
- fail "Missing the required parameter 'id' when calling post_ivrs_actions_publish" if id.nil?
217
-
218
- # resource path
219
- path = "/api/v2/architect/ivrs/actions/publish".sub('{format}','json')
220
-
221
- # query parameters
222
- query_params = {}
223
- query_params[:'id'] = id
224
-
225
- # header parameters
226
- header_params = {}
227
-
228
- # HTTP header 'Accept' (if needed)
229
- _header_accept = ['application/json']
230
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
231
-
232
- # HTTP header 'Content-Type'
233
- _header_content_type = ['application/json']
234
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
235
-
236
- # form parameters
237
- form_params = {}
238
-
239
- # http body (model)
240
- post_body = nil
241
-
242
-
243
- auth_names = ['PureCloud Auth']
244
- data, status_code, headers = @api_client.call_api(:POST, path,
245
- :header_params => header_params,
246
- :query_params => query_params,
247
- :form_params => form_params,
248
- :body => post_body,
249
- :auth_names => auth_names,
250
- :return_type => 'IVR')
251
- if @api_client.config.debugging
252
- @api_client.config.logger.debug "API called: ArchitectApi#post_ivrs_actions_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
253
- end
254
- return data, status_code, headers
255
- end
256
-
257
- # Get an IVR config.
258
- #
259
- # @param ivr_id IVR id
260
- # @param [Hash] opts the optional parameters
261
- # @return [IVR]
262
- def get_ivrs_ivr_id(ivr_id, opts = {})
263
- data, status_code, headers = get_ivrs_ivr_id_with_http_info(ivr_id, opts)
264
- return data
265
- end
266
-
267
- # Get an IVR config.
268
- #
269
- # @param ivr_id IVR id
270
- # @param [Hash] opts the optional parameters
271
- # @return [Array<(IVR, Fixnum, Hash)>] IVR data, response status code and response headers
272
- def get_ivrs_ivr_id_with_http_info(ivr_id, opts = {})
273
- if @api_client.config.debugging
274
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_ivrs_ivr_id ..."
275
- end
276
-
277
- # verify the required parameter 'ivr_id' is set
278
- fail "Missing the required parameter 'ivr_id' when calling get_ivrs_ivr_id" if ivr_id.nil?
279
-
280
- # resource path
281
- path = "/api/v2/architect/ivrs/{ivrId}".sub('{format}','json').sub('{' + 'ivrId' + '}', ivr_id.to_s)
282
-
283
- # query parameters
284
- query_params = {}
285
-
286
- # header parameters
287
- header_params = {}
288
-
289
- # HTTP header 'Accept' (if needed)
290
- _header_accept = ['application/json']
291
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
292
-
293
- # HTTP header 'Content-Type'
294
- _header_content_type = ['application/json']
295
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
296
-
297
- # form parameters
298
- form_params = {}
299
-
300
- # http body (model)
301
- post_body = nil
302
-
303
-
304
- auth_names = ['PureCloud Auth']
305
- data, status_code, headers = @api_client.call_api(:GET, path,
306
- :header_params => header_params,
307
- :query_params => query_params,
308
- :form_params => form_params,
309
- :body => post_body,
310
- :auth_names => auth_names,
311
- :return_type => 'IVR')
312
- if @api_client.config.debugging
313
- @api_client.config.logger.debug "API called: ArchitectApi#get_ivrs_ivr_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
- end
315
- return data, status_code, headers
316
- end
317
-
318
- # Update an IVR Config.
319
- #
320
- # @param ivr_id IVR id
321
- # @param [Hash] opts the optional parameters
322
- # @option opts [IVR] :body
323
- # @return [IVR]
324
- def put_ivrs_ivr_id(ivr_id, opts = {})
325
- data, status_code, headers = put_ivrs_ivr_id_with_http_info(ivr_id, opts)
326
- return data
327
- end
328
-
329
- # Update an IVR Config.
330
- #
331
- # @param ivr_id IVR id
332
- # @param [Hash] opts the optional parameters
333
- # @option opts [IVR] :body
334
- # @return [Array<(IVR, Fixnum, Hash)>] IVR data, response status code and response headers
335
- def put_ivrs_ivr_id_with_http_info(ivr_id, opts = {})
336
- if @api_client.config.debugging
337
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_ivrs_ivr_id ..."
338
- end
339
-
340
- # verify the required parameter 'ivr_id' is set
341
- fail "Missing the required parameter 'ivr_id' when calling put_ivrs_ivr_id" if ivr_id.nil?
342
-
343
- # resource path
344
- path = "/api/v2/architect/ivrs/{ivrId}".sub('{format}','json').sub('{' + 'ivrId' + '}', ivr_id.to_s)
345
-
346
- # query parameters
347
- query_params = {}
348
-
349
- # header parameters
350
- header_params = {}
351
-
352
- # HTTP header 'Accept' (if needed)
353
- _header_accept = ['application/json']
354
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
355
-
356
- # HTTP header 'Content-Type'
357
- _header_content_type = ['application/json']
358
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
359
-
360
- # form parameters
361
- form_params = {}
362
-
363
- # http body (model)
364
- post_body = @api_client.object_to_http_body(opts[:'body'])
365
-
366
-
367
- auth_names = ['PureCloud Auth']
368
- data, status_code, headers = @api_client.call_api(:PUT, path,
369
- :header_params => header_params,
370
- :query_params => query_params,
371
- :form_params => form_params,
372
- :body => post_body,
373
- :auth_names => auth_names,
374
- :return_type => 'IVR')
375
- if @api_client.config.debugging
376
- @api_client.config.logger.debug "API called: ArchitectApi#put_ivrs_ivr_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
377
- end
378
- return data, status_code, headers
379
- end
380
-
381
- # Delete an IVR Config.
382
- #
383
- # @param ivr_id IVR id
384
- # @param [Hash] opts the optional parameters
385
- # @return [String]
386
- def delete_ivrs_ivr_id(ivr_id, opts = {})
387
- data, status_code, headers = delete_ivrs_ivr_id_with_http_info(ivr_id, opts)
388
- return data
389
- end
390
-
391
- # Delete an IVR Config.
392
- #
393
- # @param ivr_id IVR id
394
- # @param [Hash] opts the optional parameters
395
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
396
- def delete_ivrs_ivr_id_with_http_info(ivr_id, opts = {})
397
- if @api_client.config.debugging
398
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_ivrs_ivr_id ..."
399
- end
400
-
401
- # verify the required parameter 'ivr_id' is set
402
- fail "Missing the required parameter 'ivr_id' when calling delete_ivrs_ivr_id" if ivr_id.nil?
403
-
404
- # resource path
405
- path = "/api/v2/architect/ivrs/{ivrId}".sub('{format}','json').sub('{' + 'ivrId' + '}', ivr_id.to_s)
406
-
407
- # query parameters
408
- query_params = {}
409
-
410
- # header parameters
411
- header_params = {}
412
-
413
- # HTTP header 'Accept' (if needed)
414
- _header_accept = ['application/json']
415
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
416
-
417
- # HTTP header 'Content-Type'
418
- _header_content_type = ['application/json']
419
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
420
-
421
- # form parameters
422
- form_params = {}
423
-
424
- # http body (model)
425
- post_body = nil
426
-
427
-
428
- auth_names = ['PureCloud Auth']
429
- data, status_code, headers = @api_client.call_api(:DELETE, path,
430
- :header_params => header_params,
431
- :query_params => query_params,
432
- :form_params => form_params,
433
- :body => post_body,
434
- :auth_names => auth_names,
435
- :return_type => 'String')
436
- if @api_client.config.debugging
437
- @api_client.config.logger.debug "API called: ArchitectApi#delete_ivrs_ivr_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
- end
439
- return data, status_code, headers
440
- end
441
-
442
- # Get a pageable list of user prompts
443
- # 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.
444
- # @param [Hash] opts the optional parameters
445
- # @option opts [Integer] :page_number Page number
446
- # @option opts [Integer] :page_size Page size
447
- # @option opts [String] :name Name
448
- # @option opts [String] :description Description
449
- # @option opts [String] :name_or_description Name or description
450
- # @return [PromptEntityListing]
451
- def get_prompts(opts = {})
452
- data, status_code, headers = get_prompts_with_http_info(opts)
453
- return data
454
- end
455
-
456
- # Get a pageable list of user prompts
457
- # 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.
458
- # @param [Hash] opts the optional parameters
459
- # @option opts [Integer] :page_number Page number
460
- # @option opts [Integer] :page_size Page size
461
- # @option opts [String] :name Name
462
- # @option opts [String] :description Description
463
- # @option opts [String] :name_or_description Name or description
464
- # @return [Array<(PromptEntityListing, Fixnum, Hash)>] PromptEntityListing data, response status code and response headers
465
- def get_prompts_with_http_info(opts = {})
466
- if @api_client.config.debugging
467
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts ..."
468
- end
469
-
470
- # resource path
471
- path = "/api/v2/architect/prompts".sub('{format}','json')
472
-
473
- # query parameters
474
- query_params = {}
475
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
476
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
477
- query_params[:'name'] = opts[:'name'] if opts[:'name']
478
- query_params[:'description'] = opts[:'description'] if opts[:'description']
479
- query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
480
-
481
- # header parameters
482
- header_params = {}
483
-
484
- # HTTP header 'Accept' (if needed)
485
- _header_accept = ['application/json']
486
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
487
-
488
- # HTTP header 'Content-Type'
489
- _header_content_type = ['application/json']
490
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
491
-
492
- # form parameters
493
- form_params = {}
494
-
495
- # http body (model)
496
- post_body = nil
497
-
498
-
499
- auth_names = ['PureCloud Auth']
500
- data, status_code, headers = @api_client.call_api(:GET, path,
501
- :header_params => header_params,
502
- :query_params => query_params,
503
- :form_params => form_params,
504
- :body => post_body,
505
- :auth_names => auth_names,
506
- :return_type => 'PromptEntityListing')
507
- if @api_client.config.debugging
508
- @api_client.config.logger.debug "API called: ArchitectApi#get_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
509
- end
510
- return data, status_code, headers
511
- end
512
-
513
- # Create a new user prompt
514
- #
515
- # @param [Hash] opts the optional parameters
516
- # @option opts [Prompt] :body
517
- # @return [Prompt]
518
- def post_prompts(opts = {})
519
- data, status_code, headers = post_prompts_with_http_info(opts)
520
- return data
521
- end
522
-
523
- # Create a new user prompt
524
- #
525
- # @param [Hash] opts the optional parameters
526
- # @option opts [Prompt] :body
527
- # @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
528
- def post_prompts_with_http_info(opts = {})
529
- if @api_client.config.debugging
530
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_prompts ..."
531
- end
532
-
533
- # resource path
534
- path = "/api/v2/architect/prompts".sub('{format}','json')
535
-
536
- # query parameters
537
- query_params = {}
538
-
539
- # header parameters
540
- header_params = {}
541
-
542
- # HTTP header 'Accept' (if needed)
543
- _header_accept = ['application/json']
544
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
545
-
546
- # HTTP header 'Content-Type'
547
- _header_content_type = ['application/json']
548
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
549
-
550
- # form parameters
551
- form_params = {}
552
-
553
- # http body (model)
554
- post_body = @api_client.object_to_http_body(opts[:'body'])
555
-
556
-
557
- auth_names = ['PureCloud Auth']
558
- data, status_code, headers = @api_client.call_api(:POST, path,
559
- :header_params => header_params,
560
- :query_params => query_params,
561
- :form_params => form_params,
562
- :body => post_body,
563
- :auth_names => auth_names,
564
- :return_type => 'Prompt')
565
- if @api_client.config.debugging
566
- @api_client.config.logger.debug "API called: ArchitectApi#post_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
567
- end
568
- return data, status_code, headers
569
- end
570
-
571
- # Batch-delete a list of prompts
572
- # Multiple IDs can be specified, in which case all specified prompts will be deleted.
573
- # @param id List of Prompt IDs
574
- # @param [Hash] opts the optional parameters
575
- # @option opts [BOOLEAN] :ignore_dependencies Ignore Dependencies
576
- # @return [nil]
577
- def delete_prompts(id, opts = {})
578
- delete_prompts_with_http_info(id, opts)
579
- return nil
580
- end
581
-
582
- # Batch-delete a list of prompts
583
- # Multiple IDs can be specified, in which case all specified prompts will be deleted.
584
- # @param id List of Prompt IDs
585
- # @param [Hash] opts the optional parameters
586
- # @option opts [BOOLEAN] :ignore_dependencies Ignore Dependencies
587
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
588
- def delete_prompts_with_http_info(id, opts = {})
589
- if @api_client.config.debugging
590
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts ..."
591
- end
592
-
593
- # verify the required parameter 'id' is set
594
- fail "Missing the required parameter 'id' when calling delete_prompts" if id.nil?
595
-
596
- # resource path
597
- path = "/api/v2/architect/prompts".sub('{format}','json')
598
-
599
- # query parameters
600
- query_params = {}
601
- query_params[:'id'] = @api_client.build_collection_param(id, :multi)
602
- query_params[:'ignoreDependencies'] = opts[:'ignore_dependencies'] if opts[:'ignore_dependencies']
603
-
604
- # header parameters
605
- header_params = {}
606
-
607
- # HTTP header 'Accept' (if needed)
608
- _header_accept = ['application/json']
609
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
610
-
611
- # HTTP header 'Content-Type'
612
- _header_content_type = ['application/json']
613
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
614
-
615
- # form parameters
616
- form_params = {}
617
-
618
- # http body (model)
619
- post_body = nil
620
-
621
-
622
- auth_names = ['PureCloud Auth']
623
- data, status_code, headers = @api_client.call_api(:DELETE, path,
624
- :header_params => header_params,
625
- :query_params => query_params,
626
- :form_params => form_params,
627
- :body => post_body,
628
- :auth_names => auth_names)
629
- if @api_client.config.debugging
630
- @api_client.config.logger.debug "API called: ArchitectApi#delete_prompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
631
- end
632
- return data, status_code, headers
633
- end
634
-
635
- # Get specified user prompt
636
- #
637
- # @param prompt_id Prompt ID
638
- # @param [Hash] opts the optional parameters
639
- # @return [Prompt]
640
- def get_prompts_prompt_id(prompt_id, opts = {})
641
- data, status_code, headers = get_prompts_prompt_id_with_http_info(prompt_id, opts)
642
- return data
643
- end
644
-
645
- # Get specified user prompt
646
- #
647
- # @param prompt_id Prompt ID
648
- # @param [Hash] opts the optional parameters
649
- # @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
650
- def get_prompts_prompt_id_with_http_info(prompt_id, opts = {})
651
- if @api_client.config.debugging
652
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id ..."
653
- end
654
-
655
- # verify the required parameter 'prompt_id' is set
656
- fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id" if prompt_id.nil?
657
-
658
- # resource path
659
- path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
660
-
661
- # query parameters
662
- query_params = {}
663
-
664
- # header parameters
665
- header_params = {}
666
-
667
- # HTTP header 'Accept' (if needed)
668
- _header_accept = ['application/json']
669
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
670
-
671
- # HTTP header 'Content-Type'
672
- _header_content_type = ['application/json']
673
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
674
-
675
- # form parameters
676
- form_params = {}
677
-
678
- # http body (model)
679
- post_body = nil
680
-
681
-
682
- auth_names = ['PureCloud Auth']
683
- data, status_code, headers = @api_client.call_api(:GET, path,
684
- :header_params => header_params,
685
- :query_params => query_params,
686
- :form_params => form_params,
687
- :body => post_body,
688
- :auth_names => auth_names,
689
- :return_type => 'Prompt')
690
- if @api_client.config.debugging
691
- @api_client.config.logger.debug "API called: ArchitectApi#get_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
692
- end
693
- return data, status_code, headers
694
- end
695
-
696
- # Update specified user prompt
697
- #
698
- # @param prompt_id Prompt ID
699
- # @param [Hash] opts the optional parameters
700
- # @option opts [Prompt] :body
701
- # @return [Prompt]
702
- def put_prompts_prompt_id(prompt_id, opts = {})
703
- data, status_code, headers = put_prompts_prompt_id_with_http_info(prompt_id, opts)
704
- return data
705
- end
706
-
707
- # Update specified user prompt
708
- #
709
- # @param prompt_id Prompt ID
710
- # @param [Hash] opts the optional parameters
711
- # @option opts [Prompt] :body
712
- # @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
713
- def put_prompts_prompt_id_with_http_info(prompt_id, opts = {})
714
- if @api_client.config.debugging
715
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_prompts_prompt_id ..."
716
- end
717
-
718
- # verify the required parameter 'prompt_id' is set
719
- fail "Missing the required parameter 'prompt_id' when calling put_prompts_prompt_id" if prompt_id.nil?
720
-
721
- # resource path
722
- path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
723
-
724
- # query parameters
725
- query_params = {}
726
-
727
- # header parameters
728
- header_params = {}
729
-
730
- # HTTP header 'Accept' (if needed)
731
- _header_accept = ['application/json']
732
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
733
-
734
- # HTTP header 'Content-Type'
735
- _header_content_type = ['application/json']
736
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
737
-
738
- # form parameters
739
- form_params = {}
740
-
741
- # http body (model)
742
- post_body = @api_client.object_to_http_body(opts[:'body'])
743
-
744
-
745
- auth_names = ['PureCloud Auth']
746
- data, status_code, headers = @api_client.call_api(:PUT, path,
747
- :header_params => header_params,
748
- :query_params => query_params,
749
- :form_params => form_params,
750
- :body => post_body,
751
- :auth_names => auth_names,
752
- :return_type => 'Prompt')
753
- if @api_client.config.debugging
754
- @api_client.config.logger.debug "API called: ArchitectApi#put_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
755
- end
756
- return data, status_code, headers
757
- end
758
-
759
- # Delete specified user prompt
760
- #
761
- # @param prompt_id Prompt ID
762
- # @param [Hash] opts the optional parameters
763
- # @return [nil]
764
- def delete_prompts_prompt_id(prompt_id, opts = {})
765
- delete_prompts_prompt_id_with_http_info(prompt_id, opts)
766
- return nil
767
- end
768
-
769
- # Delete specified user prompt
770
- #
771
- # @param prompt_id Prompt ID
772
- # @param [Hash] opts the optional parameters
773
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
774
- def delete_prompts_prompt_id_with_http_info(prompt_id, opts = {})
775
- if @api_client.config.debugging
776
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts_prompt_id ..."
777
- end
778
-
779
- # verify the required parameter 'prompt_id' is set
780
- fail "Missing the required parameter 'prompt_id' when calling delete_prompts_prompt_id" if prompt_id.nil?
781
-
782
- # resource path
783
- path = "/api/v2/architect/prompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
784
-
785
- # query parameters
786
- query_params = {}
787
-
788
- # header parameters
789
- header_params = {}
790
-
791
- # HTTP header 'Accept' (if needed)
792
- _header_accept = ['application/json']
793
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
794
-
795
- # HTTP header 'Content-Type'
796
- _header_content_type = ['application/json']
797
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
798
-
799
- # form parameters
800
- form_params = {}
801
-
802
- # http body (model)
803
- post_body = nil
804
-
805
-
806
- auth_names = ['PureCloud Auth']
807
- data, status_code, headers = @api_client.call_api(:DELETE, path,
808
- :header_params => header_params,
809
- :query_params => query_params,
810
- :form_params => form_params,
811
- :body => post_body,
812
- :auth_names => auth_names)
813
- if @api_client.config.debugging
814
- @api_client.config.logger.debug "API called: ArchitectApi#delete_prompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
815
- end
816
- return data, status_code, headers
817
- end
818
-
819
- # Get a pageable list of user prompt resources
820
- # The returned list is pageable, and query paramaters can be used for filtering.
821
- # @param prompt_id Prompt ID
822
- # @param [Hash] opts the optional parameters
823
- # @option opts [Integer] :page_number Page number
824
- # @option opts [Integer] :page_size Page size
825
- # @return [PromptAssetEntityListing]
826
- def get_prompts_prompt_id_resources(prompt_id, opts = {})
827
- data, status_code, headers = get_prompts_prompt_id_resources_with_http_info(prompt_id, opts)
828
- return data
829
- end
830
-
831
- # Get a pageable list of user prompt resources
832
- # The returned list is pageable, and query paramaters can be used for filtering.
833
- # @param prompt_id Prompt ID
834
- # @param [Hash] opts the optional parameters
835
- # @option opts [Integer] :page_number Page number
836
- # @option opts [Integer] :page_size Page size
837
- # @return [Array<(PromptAssetEntityListing, Fixnum, Hash)>] PromptAssetEntityListing data, response status code and response headers
838
- def get_prompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
839
- if @api_client.config.debugging
840
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id_resources ..."
841
- end
842
-
843
- # verify the required parameter 'prompt_id' is set
844
- fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id_resources" if prompt_id.nil?
845
-
846
- # resource path
847
- path = "/api/v2/architect/prompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
848
-
849
- # query parameters
850
- query_params = {}
851
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
852
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
853
-
854
- # header parameters
855
- header_params = {}
856
-
857
- # HTTP header 'Accept' (if needed)
858
- _header_accept = ['application/json']
859
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
860
-
861
- # HTTP header 'Content-Type'
862
- _header_content_type = ['application/json']
863
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
864
-
865
- # form parameters
866
- form_params = {}
867
-
868
- # http body (model)
869
- post_body = nil
870
-
871
-
872
- auth_names = ['PureCloud Auth']
873
- data, status_code, headers = @api_client.call_api(:GET, path,
874
- :header_params => header_params,
875
- :query_params => query_params,
876
- :form_params => form_params,
877
- :body => post_body,
878
- :auth_names => auth_names,
879
- :return_type => 'PromptAssetEntityListing')
880
- if @api_client.config.debugging
881
- @api_client.config.logger.debug "API called: ArchitectApi#get_prompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
882
- end
883
- return data, status_code, headers
884
- end
885
-
886
- # Create a new user prompt resource.
887
- #
888
- # @param prompt_id Prompt ID
889
- # @param [Hash] opts the optional parameters
890
- # @option opts [PromptAsset] :body
891
- # @return [PromptAsset]
892
- def post_prompts_prompt_id_resources(prompt_id, opts = {})
893
- data, status_code, headers = post_prompts_prompt_id_resources_with_http_info(prompt_id, opts)
894
- return data
895
- end
896
-
897
- # Create a new user prompt resource.
898
- #
899
- # @param prompt_id Prompt ID
900
- # @param [Hash] opts the optional parameters
901
- # @option opts [PromptAsset] :body
902
- # @return [Array<(PromptAsset, Fixnum, Hash)>] PromptAsset data, response status code and response headers
903
- def post_prompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
904
- if @api_client.config.debugging
905
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_prompts_prompt_id_resources ..."
906
- end
907
-
908
- # verify the required parameter 'prompt_id' is set
909
- fail "Missing the required parameter 'prompt_id' when calling post_prompts_prompt_id_resources" if prompt_id.nil?
910
-
911
- # resource path
912
- path = "/api/v2/architect/prompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
913
-
914
- # query parameters
915
- query_params = {}
916
-
917
- # header parameters
918
- header_params = {}
919
-
920
- # HTTP header 'Accept' (if needed)
921
- _header_accept = ['application/json']
922
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
923
-
924
- # HTTP header 'Content-Type'
925
- _header_content_type = ['application/json']
926
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
927
-
928
- # form parameters
929
- form_params = {}
930
-
931
- # http body (model)
932
- post_body = @api_client.object_to_http_body(opts[:'body'])
933
-
934
-
935
- auth_names = ['PureCloud Auth']
936
- data, status_code, headers = @api_client.call_api(:POST, path,
937
- :header_params => header_params,
938
- :query_params => query_params,
939
- :form_params => form_params,
940
- :body => post_body,
941
- :auth_names => auth_names,
942
- :return_type => 'PromptAsset')
943
- if @api_client.config.debugging
944
- @api_client.config.logger.debug "API called: ArchitectApi#post_prompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
945
- end
946
- return data, status_code, headers
947
- end
948
-
949
- # Get specified user prompt resource
950
- #
951
- # @param prompt_id Prompt ID
952
- # @param language Language
953
- # @param [Hash] opts the optional parameters
954
- # @return [PromptAsset]
955
- def get_prompts_prompt_id_resources_language(prompt_id, language, opts = {})
956
- data, status_code, headers = get_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts)
957
- return data
958
- end
959
-
960
- # Get specified user prompt resource
961
- #
962
- # @param prompt_id Prompt ID
963
- # @param language Language
964
- # @param [Hash] opts the optional parameters
965
- # @return [Array<(PromptAsset, Fixnum, Hash)>] PromptAsset data, response status code and response headers
966
- def get_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts = {})
967
- if @api_client.config.debugging
968
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_prompts_prompt_id_resources_language ..."
969
- end
970
-
971
- # verify the required parameter 'prompt_id' is set
972
- fail "Missing the required parameter 'prompt_id' when calling get_prompts_prompt_id_resources_language" if prompt_id.nil?
973
-
974
- # verify the required parameter 'language' is set
975
- fail "Missing the required parameter 'language' when calling get_prompts_prompt_id_resources_language" if language.nil?
976
-
977
- # resource path
978
- path = "/api/v2/architect/prompts/{promptId}/resources/{language}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'language' + '}', language.to_s)
979
-
980
- # query parameters
981
- query_params = {}
982
-
983
- # header parameters
984
- header_params = {}
985
-
986
- # HTTP header 'Accept' (if needed)
987
- _header_accept = ['application/json']
988
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
989
-
990
- # HTTP header 'Content-Type'
991
- _header_content_type = ['application/json']
992
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
993
-
994
- # form parameters
995
- form_params = {}
996
-
997
- # http body (model)
998
- post_body = nil
999
-
1000
-
1001
- auth_names = ['PureCloud Auth']
1002
- data, status_code, headers = @api_client.call_api(:GET, path,
1003
- :header_params => header_params,
1004
- :query_params => query_params,
1005
- :form_params => form_params,
1006
- :body => post_body,
1007
- :auth_names => auth_names,
1008
- :return_type => 'PromptAsset')
1009
- if @api_client.config.debugging
1010
- @api_client.config.logger.debug "API called: ArchitectApi#get_prompts_prompt_id_resources_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1011
- end
1012
- return data, status_code, headers
1013
- end
1014
-
1015
- # Update specified user prompt resource
1016
- #
1017
- # @param prompt_id Prompt ID
1018
- # @param language Language
1019
- # @param [Hash] opts the optional parameters
1020
- # @option opts [PromptAsset] :body
1021
- # @return [PromptAsset]
1022
- def put_prompts_prompt_id_resources_language(prompt_id, language, opts = {})
1023
- data, status_code, headers = put_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts)
1024
- return data
1025
- end
1026
-
1027
- # Update specified user prompt resource
1028
- #
1029
- # @param prompt_id Prompt ID
1030
- # @param language Language
1031
- # @param [Hash] opts the optional parameters
1032
- # @option opts [PromptAsset] :body
1033
- # @return [Array<(PromptAsset, Fixnum, Hash)>] PromptAsset data, response status code and response headers
1034
- def put_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts = {})
1035
- if @api_client.config.debugging
1036
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_prompts_prompt_id_resources_language ..."
1037
- end
1038
-
1039
- # verify the required parameter 'prompt_id' is set
1040
- fail "Missing the required parameter 'prompt_id' when calling put_prompts_prompt_id_resources_language" if prompt_id.nil?
1041
-
1042
- # verify the required parameter 'language' is set
1043
- fail "Missing the required parameter 'language' when calling put_prompts_prompt_id_resources_language" if language.nil?
1044
-
1045
- # resource path
1046
- path = "/api/v2/architect/prompts/{promptId}/resources/{language}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'language' + '}', language.to_s)
1047
-
1048
- # query parameters
1049
- query_params = {}
1050
-
1051
- # header parameters
1052
- header_params = {}
1053
-
1054
- # HTTP header 'Accept' (if needed)
1055
- _header_accept = ['application/json']
1056
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1057
-
1058
- # HTTP header 'Content-Type'
1059
- _header_content_type = ['application/json']
1060
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1061
-
1062
- # form parameters
1063
- form_params = {}
1064
-
1065
- # http body (model)
1066
- post_body = @api_client.object_to_http_body(opts[:'body'])
1067
-
1068
-
1069
- auth_names = ['PureCloud Auth']
1070
- data, status_code, headers = @api_client.call_api(:PUT, path,
1071
- :header_params => header_params,
1072
- :query_params => query_params,
1073
- :form_params => form_params,
1074
- :body => post_body,
1075
- :auth_names => auth_names,
1076
- :return_type => 'PromptAsset')
1077
- if @api_client.config.debugging
1078
- @api_client.config.logger.debug "API called: ArchitectApi#put_prompts_prompt_id_resources_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1079
- end
1080
- return data, status_code, headers
1081
- end
1082
-
1083
- # Delete specified user prompt resource
1084
- #
1085
- # @param prompt_id Prompt ID
1086
- # @param language Language
1087
- # @param [Hash] opts the optional parameters
1088
- # @return [nil]
1089
- def delete_prompts_prompt_id_resources_language(prompt_id, language, opts = {})
1090
- delete_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts)
1091
- return nil
1092
- end
1093
-
1094
- # Delete specified user prompt resource
1095
- #
1096
- # @param prompt_id Prompt ID
1097
- # @param language Language
1098
- # @param [Hash] opts the optional parameters
1099
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1100
- def delete_prompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts = {})
1101
- if @api_client.config.debugging
1102
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_prompts_prompt_id_resources_language ..."
1103
- end
1104
-
1105
- # verify the required parameter 'prompt_id' is set
1106
- fail "Missing the required parameter 'prompt_id' when calling delete_prompts_prompt_id_resources_language" if prompt_id.nil?
1107
-
1108
- # verify the required parameter 'language' is set
1109
- fail "Missing the required parameter 'language' when calling delete_prompts_prompt_id_resources_language" if language.nil?
1110
-
1111
- # resource path
1112
- path = "/api/v2/architect/prompts/{promptId}/resources/{language}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'language' + '}', language.to_s)
1113
-
1114
- # query parameters
1115
- query_params = {}
1116
-
1117
- # header parameters
1118
- header_params = {}
1119
-
1120
- # HTTP header 'Accept' (if needed)
1121
- _header_accept = ['application/json']
1122
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1123
-
1124
- # HTTP header 'Content-Type'
1125
- _header_content_type = ['application/json']
1126
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1127
-
1128
- # form parameters
1129
- form_params = {}
1130
-
1131
- # http body (model)
1132
- post_body = nil
1133
-
1134
-
1135
- auth_names = ['PureCloud Auth']
1136
- data, status_code, headers = @api_client.call_api(:DELETE, path,
1137
- :header_params => header_params,
1138
- :query_params => query_params,
1139
- :form_params => form_params,
1140
- :body => post_body,
1141
- :auth_names => auth_names)
1142
- if @api_client.config.debugging
1143
- @api_client.config.logger.debug "API called: ArchitectApi#delete_prompts_prompt_id_resources_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1144
- end
1145
- return data, status_code, headers
1146
- end
1147
-
1148
- # Get a list of schedule groups.
1149
- #
1150
- # @param [Hash] opts the optional parameters
1151
- # @option opts [Integer] :page_number Page number
1152
- # @option opts [Integer] :page_size Page size
1153
- # @option opts [String] :sort_by Sort by
1154
- # @option opts [String] :sort_order Sort order
1155
- # @return [ScheduleGroupEntityListing]
1156
- def get_schedulegroups(opts = {})
1157
- data, status_code, headers = get_schedulegroups_with_http_info(opts)
1158
- return data
1159
- end
1160
-
1161
- # Get a list of schedule groups.
1162
- #
1163
- # @param [Hash] opts the optional parameters
1164
- # @option opts [Integer] :page_number Page number
1165
- # @option opts [Integer] :page_size Page size
1166
- # @option opts [String] :sort_by Sort by
1167
- # @option opts [String] :sort_order Sort order
1168
- # @return [Array<(ScheduleGroupEntityListing, Fixnum, Hash)>] ScheduleGroupEntityListing data, response status code and response headers
1169
- def get_schedulegroups_with_http_info(opts = {})
1170
- if @api_client.config.debugging
1171
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_schedulegroups ..."
1172
- end
1173
-
1174
- # resource path
1175
- path = "/api/v2/architect/schedulegroups".sub('{format}','json')
1176
-
1177
- # query parameters
1178
- query_params = {}
1179
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1180
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1181
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1182
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1183
-
1184
- # header parameters
1185
- header_params = {}
1186
-
1187
- # HTTP header 'Accept' (if needed)
1188
- _header_accept = ['application/json']
1189
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1190
-
1191
- # HTTP header 'Content-Type'
1192
- _header_content_type = ['application/json']
1193
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1194
-
1195
- # form parameters
1196
- form_params = {}
1197
-
1198
- # http body (model)
1199
- post_body = nil
1200
-
1201
-
1202
- auth_names = ['PureCloud Auth']
1203
- data, status_code, headers = @api_client.call_api(:GET, path,
1204
- :header_params => header_params,
1205
- :query_params => query_params,
1206
- :form_params => form_params,
1207
- :body => post_body,
1208
- :auth_names => auth_names,
1209
- :return_type => 'ScheduleGroupEntityListing')
1210
- if @api_client.config.debugging
1211
- @api_client.config.logger.debug "API called: ArchitectApi#get_schedulegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1212
- end
1213
- return data, status_code, headers
1214
- end
1215
-
1216
- # Creates a new schedule group
1217
- #
1218
- # @param [Hash] opts the optional parameters
1219
- # @option opts [ScheduleGroup] :body
1220
- # @return [ScheduleGroup]
1221
- def post_schedulegroups(opts = {})
1222
- data, status_code, headers = post_schedulegroups_with_http_info(opts)
1223
- return data
1224
- end
1225
-
1226
- # Creates a new schedule group
1227
- #
1228
- # @param [Hash] opts the optional parameters
1229
- # @option opts [ScheduleGroup] :body
1230
- # @return [Array<(ScheduleGroup, Fixnum, Hash)>] ScheduleGroup data, response status code and response headers
1231
- def post_schedulegroups_with_http_info(opts = {})
1232
- if @api_client.config.debugging
1233
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_schedulegroups ..."
1234
- end
1235
-
1236
- # resource path
1237
- path = "/api/v2/architect/schedulegroups".sub('{format}','json')
1238
-
1239
- # query parameters
1240
- query_params = {}
1241
-
1242
- # header parameters
1243
- header_params = {}
1244
-
1245
- # HTTP header 'Accept' (if needed)
1246
- _header_accept = ['application/json']
1247
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1248
-
1249
- # HTTP header 'Content-Type'
1250
- _header_content_type = ['application/json']
1251
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1252
-
1253
- # form parameters
1254
- form_params = {}
1255
-
1256
- # http body (model)
1257
- post_body = @api_client.object_to_http_body(opts[:'body'])
1258
-
1259
-
1260
- auth_names = ['PureCloud Auth']
1261
- data, status_code, headers = @api_client.call_api(:POST, path,
1262
- :header_params => header_params,
1263
- :query_params => query_params,
1264
- :form_params => form_params,
1265
- :body => post_body,
1266
- :auth_names => auth_names,
1267
- :return_type => 'ScheduleGroup')
1268
- if @api_client.config.debugging
1269
- @api_client.config.logger.debug "API called: ArchitectApi#post_schedulegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1270
- end
1271
- return data, status_code, headers
1272
- end
1273
-
1274
- # Gets a schedule group by ID
1275
- #
1276
- # @param schedule_group_id Schedule group ID
1277
- # @param [Hash] opts the optional parameters
1278
- # @return [ScheduleGroup]
1279
- def get_schedulegroups_schedulegroup_id(schedule_group_id, opts = {})
1280
- data, status_code, headers = get_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts)
1281
- return data
1282
- end
1283
-
1284
- # Gets a schedule group by ID
1285
- #
1286
- # @param schedule_group_id Schedule group ID
1287
- # @param [Hash] opts the optional parameters
1288
- # @return [Array<(ScheduleGroup, Fixnum, Hash)>] ScheduleGroup data, response status code and response headers
1289
- def get_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts = {})
1290
- if @api_client.config.debugging
1291
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_schedulegroups_schedulegroup_id ..."
1292
- end
1293
-
1294
- # verify the required parameter 'schedule_group_id' is set
1295
- fail "Missing the required parameter 'schedule_group_id' when calling get_schedulegroups_schedulegroup_id" if schedule_group_id.nil?
1296
-
1297
- # resource path
1298
- path = "/api/v2/architect/schedulegroups/{scheduleGroupId}".sub('{format}','json').sub('{' + 'scheduleGroupId' + '}', schedule_group_id.to_s)
1299
-
1300
- # query parameters
1301
- query_params = {}
1302
-
1303
- # header parameters
1304
- header_params = {}
1305
-
1306
- # HTTP header 'Accept' (if needed)
1307
- _header_accept = ['application/json']
1308
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1309
-
1310
- # HTTP header 'Content-Type'
1311
- _header_content_type = ['application/json']
1312
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1313
-
1314
- # form parameters
1315
- form_params = {}
1316
-
1317
- # http body (model)
1318
- post_body = nil
1319
-
1320
-
1321
- auth_names = ['PureCloud Auth']
1322
- data, status_code, headers = @api_client.call_api(:GET, path,
1323
- :header_params => header_params,
1324
- :query_params => query_params,
1325
- :form_params => form_params,
1326
- :body => post_body,
1327
- :auth_names => auth_names,
1328
- :return_type => 'ScheduleGroup')
1329
- if @api_client.config.debugging
1330
- @api_client.config.logger.debug "API called: ArchitectApi#get_schedulegroups_schedulegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1331
- end
1332
- return data, status_code, headers
1333
- end
1334
-
1335
- # Updates a schedule group by ID
1336
- #
1337
- # @param schedule_group_id Schedule group ID
1338
- # @param [Hash] opts the optional parameters
1339
- # @option opts [ScheduleGroup] :body
1340
- # @return [ScheduleGroup]
1341
- def put_schedulegroups_schedulegroup_id(schedule_group_id, opts = {})
1342
- data, status_code, headers = put_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts)
1343
- return data
1344
- end
1345
-
1346
- # Updates a schedule group by ID
1347
- #
1348
- # @param schedule_group_id Schedule group ID
1349
- # @param [Hash] opts the optional parameters
1350
- # @option opts [ScheduleGroup] :body
1351
- # @return [Array<(ScheduleGroup, Fixnum, Hash)>] ScheduleGroup data, response status code and response headers
1352
- def put_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts = {})
1353
- if @api_client.config.debugging
1354
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_schedulegroups_schedulegroup_id ..."
1355
- end
1356
-
1357
- # verify the required parameter 'schedule_group_id' is set
1358
- fail "Missing the required parameter 'schedule_group_id' when calling put_schedulegroups_schedulegroup_id" if schedule_group_id.nil?
1359
-
1360
- # resource path
1361
- path = "/api/v2/architect/schedulegroups/{scheduleGroupId}".sub('{format}','json').sub('{' + 'scheduleGroupId' + '}', schedule_group_id.to_s)
1362
-
1363
- # query parameters
1364
- query_params = {}
1365
-
1366
- # header parameters
1367
- header_params = {}
1368
-
1369
- # HTTP header 'Accept' (if needed)
1370
- _header_accept = ['application/json']
1371
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1372
-
1373
- # HTTP header 'Content-Type'
1374
- _header_content_type = ['application/json']
1375
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1376
-
1377
- # form parameters
1378
- form_params = {}
1379
-
1380
- # http body (model)
1381
- post_body = @api_client.object_to_http_body(opts[:'body'])
1382
-
1383
-
1384
- auth_names = ['PureCloud Auth']
1385
- data, status_code, headers = @api_client.call_api(:PUT, path,
1386
- :header_params => header_params,
1387
- :query_params => query_params,
1388
- :form_params => form_params,
1389
- :body => post_body,
1390
- :auth_names => auth_names,
1391
- :return_type => 'ScheduleGroup')
1392
- if @api_client.config.debugging
1393
- @api_client.config.logger.debug "API called: ArchitectApi#put_schedulegroups_schedulegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1394
- end
1395
- return data, status_code, headers
1396
- end
1397
-
1398
- # Deletes a schedule group by ID
1399
- #
1400
- # @param schedule_group_id Schedule group ID
1401
- # @param [Hash] opts the optional parameters
1402
- # @return [String]
1403
- def delete_schedulegroups_schedulegroup_id(schedule_group_id, opts = {})
1404
- data, status_code, headers = delete_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts)
1405
- return data
1406
- end
1407
-
1408
- # Deletes a schedule group by ID
1409
- #
1410
- # @param schedule_group_id Schedule group ID
1411
- # @param [Hash] opts the optional parameters
1412
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1413
- def delete_schedulegroups_schedulegroup_id_with_http_info(schedule_group_id, opts = {})
1414
- if @api_client.config.debugging
1415
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_schedulegroups_schedulegroup_id ..."
1416
- end
1417
-
1418
- # verify the required parameter 'schedule_group_id' is set
1419
- fail "Missing the required parameter 'schedule_group_id' when calling delete_schedulegroups_schedulegroup_id" if schedule_group_id.nil?
1420
-
1421
- # resource path
1422
- path = "/api/v2/architect/schedulegroups/{scheduleGroupId}".sub('{format}','json').sub('{' + 'scheduleGroupId' + '}', schedule_group_id.to_s)
1423
-
1424
- # query parameters
1425
- query_params = {}
1426
-
1427
- # header parameters
1428
- header_params = {}
1429
-
1430
- # HTTP header 'Accept' (if needed)
1431
- _header_accept = ['application/json']
1432
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1433
-
1434
- # HTTP header 'Content-Type'
1435
- _header_content_type = ['application/json']
1436
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1437
-
1438
- # form parameters
1439
- form_params = {}
1440
-
1441
- # http body (model)
1442
- post_body = nil
1443
-
1444
-
1445
- auth_names = ['PureCloud Auth']
1446
- data, status_code, headers = @api_client.call_api(:DELETE, path,
1447
- :header_params => header_params,
1448
- :query_params => query_params,
1449
- :form_params => form_params,
1450
- :body => post_body,
1451
- :auth_names => auth_names,
1452
- :return_type => 'String')
1453
- if @api_client.config.debugging
1454
- @api_client.config.logger.debug "API called: ArchitectApi#delete_schedulegroups_schedulegroup_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1455
- end
1456
- return data, status_code, headers
1457
- end
1458
-
1459
- # Get a list of schedules.
1460
- #
1461
- # @param [Hash] opts the optional parameters
1462
- # @option opts [Integer] :page_number Page number
1463
- # @option opts [Integer] :page_size Page size
1464
- # @option opts [String] :sort_by Sort by
1465
- # @option opts [String] :sort_order Sort order
1466
- # @return [ScheduleEntityListing]
1467
- def get_schedules(opts = {})
1468
- data, status_code, headers = get_schedules_with_http_info(opts)
1469
- return data
1470
- end
1471
-
1472
- # Get a list of schedules.
1473
- #
1474
- # @param [Hash] opts the optional parameters
1475
- # @option opts [Integer] :page_number Page number
1476
- # @option opts [Integer] :page_size Page size
1477
- # @option opts [String] :sort_by Sort by
1478
- # @option opts [String] :sort_order Sort order
1479
- # @return [Array<(ScheduleEntityListing, Fixnum, Hash)>] ScheduleEntityListing data, response status code and response headers
1480
- def get_schedules_with_http_info(opts = {})
1481
- if @api_client.config.debugging
1482
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_schedules ..."
1483
- end
1484
-
1485
- # resource path
1486
- path = "/api/v2/architect/schedules".sub('{format}','json')
1487
-
1488
- # query parameters
1489
- query_params = {}
1490
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1491
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1492
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1493
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1494
-
1495
- # header parameters
1496
- header_params = {}
1497
-
1498
- # HTTP header 'Accept' (if needed)
1499
- _header_accept = ['application/json']
1500
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1501
-
1502
- # HTTP header 'Content-Type'
1503
- _header_content_type = ['application/json']
1504
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1505
-
1506
- # form parameters
1507
- form_params = {}
1508
-
1509
- # http body (model)
1510
- post_body = nil
1511
-
1512
-
1513
- auth_names = ['PureCloud Auth']
1514
- data, status_code, headers = @api_client.call_api(:GET, path,
1515
- :header_params => header_params,
1516
- :query_params => query_params,
1517
- :form_params => form_params,
1518
- :body => post_body,
1519
- :auth_names => auth_names,
1520
- :return_type => 'ScheduleEntityListing')
1521
- if @api_client.config.debugging
1522
- @api_client.config.logger.debug "API called: ArchitectApi#get_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1523
- end
1524
- return data, status_code, headers
1525
- end
1526
-
1527
- # Create a new schedule.
1528
- #
1529
- # @param [Hash] opts the optional parameters
1530
- # @option opts [Schedule] :body
1531
- # @return [Schedule]
1532
- def post_schedules(opts = {})
1533
- data, status_code, headers = post_schedules_with_http_info(opts)
1534
- return data
1535
- end
1536
-
1537
- # Create a new schedule.
1538
- #
1539
- # @param [Hash] opts the optional parameters
1540
- # @option opts [Schedule] :body
1541
- # @return [Array<(Schedule, Fixnum, Hash)>] Schedule data, response status code and response headers
1542
- def post_schedules_with_http_info(opts = {})
1543
- if @api_client.config.debugging
1544
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_schedules ..."
1545
- end
1546
-
1547
- # resource path
1548
- path = "/api/v2/architect/schedules".sub('{format}','json')
1549
-
1550
- # query parameters
1551
- query_params = {}
1552
-
1553
- # header parameters
1554
- header_params = {}
1555
-
1556
- # HTTP header 'Accept' (if needed)
1557
- _header_accept = ['application/json']
1558
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1559
-
1560
- # HTTP header 'Content-Type'
1561
- _header_content_type = ['application/json']
1562
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1563
-
1564
- # form parameters
1565
- form_params = {}
1566
-
1567
- # http body (model)
1568
- post_body = @api_client.object_to_http_body(opts[:'body'])
1569
-
1570
-
1571
- auth_names = ['PureCloud Auth']
1572
- data, status_code, headers = @api_client.call_api(:POST, path,
1573
- :header_params => header_params,
1574
- :query_params => query_params,
1575
- :form_params => form_params,
1576
- :body => post_body,
1577
- :auth_names => auth_names,
1578
- :return_type => 'Schedule')
1579
- if @api_client.config.debugging
1580
- @api_client.config.logger.debug "API called: ArchitectApi#post_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1581
- end
1582
- return data, status_code, headers
1583
- end
1584
-
1585
- # Get a schedule by ID
1586
- #
1587
- # @param schedule_id Schedule ID
1588
- # @param [Hash] opts the optional parameters
1589
- # @return [Schedule]
1590
- def get_schedules_schedule_id(schedule_id, opts = {})
1591
- data, status_code, headers = get_schedules_schedule_id_with_http_info(schedule_id, opts)
1592
- return data
1593
- end
1594
-
1595
- # Get a schedule by ID
1596
- #
1597
- # @param schedule_id Schedule ID
1598
- # @param [Hash] opts the optional parameters
1599
- # @return [Array<(Schedule, Fixnum, Hash)>] Schedule data, response status code and response headers
1600
- def get_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1601
- if @api_client.config.debugging
1602
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_schedules_schedule_id ..."
1603
- end
1604
-
1605
- # verify the required parameter 'schedule_id' is set
1606
- fail "Missing the required parameter 'schedule_id' when calling get_schedules_schedule_id" if schedule_id.nil?
1607
-
1608
- # resource path
1609
- path = "/api/v2/architect/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1610
-
1611
- # query parameters
1612
- query_params = {}
1613
-
1614
- # header parameters
1615
- header_params = {}
1616
-
1617
- # HTTP header 'Accept' (if needed)
1618
- _header_accept = ['application/json']
1619
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1620
-
1621
- # HTTP header 'Content-Type'
1622
- _header_content_type = ['application/json']
1623
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1624
-
1625
- # form parameters
1626
- form_params = {}
1627
-
1628
- # http body (model)
1629
- post_body = nil
1630
-
1631
-
1632
- auth_names = ['PureCloud Auth']
1633
- data, status_code, headers = @api_client.call_api(:GET, path,
1634
- :header_params => header_params,
1635
- :query_params => query_params,
1636
- :form_params => form_params,
1637
- :body => post_body,
1638
- :auth_names => auth_names,
1639
- :return_type => 'Schedule')
1640
- if @api_client.config.debugging
1641
- @api_client.config.logger.debug "API called: ArchitectApi#get_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1642
- end
1643
- return data, status_code, headers
1644
- end
1645
-
1646
- # Update schedule by ID
1647
- #
1648
- # @param schedule_id Schedule ID
1649
- # @param [Hash] opts the optional parameters
1650
- # @option opts [Schedule] :body
1651
- # @return [Schedule]
1652
- def put_schedules_schedule_id(schedule_id, opts = {})
1653
- data, status_code, headers = put_schedules_schedule_id_with_http_info(schedule_id, opts)
1654
- return data
1655
- end
1656
-
1657
- # Update schedule by ID
1658
- #
1659
- # @param schedule_id Schedule ID
1660
- # @param [Hash] opts the optional parameters
1661
- # @option opts [Schedule] :body
1662
- # @return [Array<(Schedule, Fixnum, Hash)>] Schedule data, response status code and response headers
1663
- def put_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1664
- if @api_client.config.debugging
1665
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_schedules_schedule_id ..."
1666
- end
1667
-
1668
- # verify the required parameter 'schedule_id' is set
1669
- fail "Missing the required parameter 'schedule_id' when calling put_schedules_schedule_id" if schedule_id.nil?
1670
-
1671
- # resource path
1672
- path = "/api/v2/architect/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1673
-
1674
- # query parameters
1675
- query_params = {}
1676
-
1677
- # header parameters
1678
- header_params = {}
1679
-
1680
- # HTTP header 'Accept' (if needed)
1681
- _header_accept = ['application/json']
1682
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1683
-
1684
- # HTTP header 'Content-Type'
1685
- _header_content_type = ['application/json']
1686
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1687
-
1688
- # form parameters
1689
- form_params = {}
1690
-
1691
- # http body (model)
1692
- post_body = @api_client.object_to_http_body(opts[:'body'])
1693
-
1694
-
1695
- auth_names = ['PureCloud Auth']
1696
- data, status_code, headers = @api_client.call_api(:PUT, path,
1697
- :header_params => header_params,
1698
- :query_params => query_params,
1699
- :form_params => form_params,
1700
- :body => post_body,
1701
- :auth_names => auth_names,
1702
- :return_type => 'Schedule')
1703
- if @api_client.config.debugging
1704
- @api_client.config.logger.debug "API called: ArchitectApi#put_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1705
- end
1706
- return data, status_code, headers
1707
- end
1708
-
1709
- # Delete a schedule by id
1710
- #
1711
- # @param schedule_id Schedule ID
1712
- # @param [Hash] opts the optional parameters
1713
- # @return [String]
1714
- def delete_schedules_schedule_id(schedule_id, opts = {})
1715
- data, status_code, headers = delete_schedules_schedule_id_with_http_info(schedule_id, opts)
1716
- return data
1717
- end
1718
-
1719
- # Delete a schedule by id
1720
- #
1721
- # @param schedule_id Schedule ID
1722
- # @param [Hash] opts the optional parameters
1723
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1724
- def delete_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1725
- if @api_client.config.debugging
1726
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_schedules_schedule_id ..."
1727
- end
1728
-
1729
- # verify the required parameter 'schedule_id' is set
1730
- fail "Missing the required parameter 'schedule_id' when calling delete_schedules_schedule_id" if schedule_id.nil?
1731
-
1732
- # resource path
1733
- path = "/api/v2/architect/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1734
-
1735
- # query parameters
1736
- query_params = {}
1737
-
1738
- # header parameters
1739
- header_params = {}
1740
-
1741
- # HTTP header 'Accept' (if needed)
1742
- _header_accept = ['application/json']
1743
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1744
-
1745
- # HTTP header 'Content-Type'
1746
- _header_content_type = ['application/json']
1747
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1748
-
1749
- # form parameters
1750
- form_params = {}
1751
-
1752
- # http body (model)
1753
- post_body = nil
1754
-
1755
-
1756
- auth_names = ['PureCloud Auth']
1757
- data, status_code, headers = @api_client.call_api(:DELETE, path,
1758
- :header_params => header_params,
1759
- :query_params => query_params,
1760
- :form_params => form_params,
1761
- :body => post_body,
1762
- :auth_names => auth_names,
1763
- :return_type => 'String')
1764
- if @api_client.config.debugging
1765
- @api_client.config.logger.debug "API called: ArchitectApi#delete_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1766
- end
1767
- return data, status_code, headers
1768
- end
1769
-
1770
- # Get System Prompts.
1771
- #
1772
- # @param [Hash] opts the optional parameters
1773
- # @option opts [Integer] :page_number Page number
1774
- # @option opts [Integer] :page_size Page size
1775
- # @option opts [String] :sort_by Sort by
1776
- # @option opts [String] :sort_order Sort order
1777
- # @option opts [String] :name Name
1778
- # @option opts [String] :description Description
1779
- # @option opts [String] :name_or_description Name or description
1780
- # @return [SystemPromptEntityListing]
1781
- def get_systemprompts(opts = {})
1782
- data, status_code, headers = get_systemprompts_with_http_info(opts)
1783
- return data
1784
- end
1785
-
1786
- # Get System Prompts.
1787
- #
1788
- # @param [Hash] opts the optional parameters
1789
- # @option opts [Integer] :page_number Page number
1790
- # @option opts [Integer] :page_size Page size
1791
- # @option opts [String] :sort_by Sort by
1792
- # @option opts [String] :sort_order Sort order
1793
- # @option opts [String] :name Name
1794
- # @option opts [String] :description Description
1795
- # @option opts [String] :name_or_description Name or description
1796
- # @return [Array<(SystemPromptEntityListing, Fixnum, Hash)>] SystemPromptEntityListing data, response status code and response headers
1797
- def get_systemprompts_with_http_info(opts = {})
1798
- if @api_client.config.debugging
1799
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts ..."
1800
- end
1801
-
1802
- # resource path
1803
- path = "/api/v2/architect/systemprompts".sub('{format}','json')
1804
-
1805
- # query parameters
1806
- query_params = {}
1807
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1808
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1809
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1810
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1811
- query_params[:'name'] = opts[:'name'] if opts[:'name']
1812
- query_params[:'description'] = opts[:'description'] if opts[:'description']
1813
- query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
1814
-
1815
- # header parameters
1816
- header_params = {}
1817
-
1818
- # HTTP header 'Accept' (if needed)
1819
- _header_accept = ['application/json']
1820
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1821
-
1822
- # HTTP header 'Content-Type'
1823
- _header_content_type = ['application/json']
1824
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1825
-
1826
- # form parameters
1827
- form_params = {}
1828
-
1829
- # http body (model)
1830
- post_body = nil
1831
-
1832
-
1833
- auth_names = ['PureCloud Auth']
1834
- data, status_code, headers = @api_client.call_api(:GET, path,
1835
- :header_params => header_params,
1836
- :query_params => query_params,
1837
- :form_params => form_params,
1838
- :body => post_body,
1839
- :auth_names => auth_names,
1840
- :return_type => 'SystemPromptEntityListing')
1841
- if @api_client.config.debugging
1842
- @api_client.config.logger.debug "API called: ArchitectApi#get_systemprompts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1843
- end
1844
- return data, status_code, headers
1845
- end
1846
-
1847
- # Get IVR system prompt.
1848
- #
1849
- # @param prompt_id
1850
- # @param [Hash] opts the optional parameters
1851
- # @return [SystemPrompt]
1852
- def get_systemprompts_prompt_id(prompt_id, opts = {})
1853
- data, status_code, headers = get_systemprompts_prompt_id_with_http_info(prompt_id, opts)
1854
- return data
1855
- end
1856
-
1857
- # Get IVR system prompt.
1858
- #
1859
- # @param prompt_id
1860
- # @param [Hash] opts the optional parameters
1861
- # @return [Array<(SystemPrompt, Fixnum, Hash)>] SystemPrompt data, response status code and response headers
1862
- def get_systemprompts_prompt_id_with_http_info(prompt_id, opts = {})
1863
- if @api_client.config.debugging
1864
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id ..."
1865
- end
1866
-
1867
- # verify the required parameter 'prompt_id' is set
1868
- fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id" if prompt_id.nil?
1869
-
1870
- # resource path
1871
- path = "/api/v2/architect/systemprompts/{promptId}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
1872
-
1873
- # query parameters
1874
- query_params = {}
1875
-
1876
- # header parameters
1877
- header_params = {}
1878
-
1879
- # HTTP header 'Accept' (if needed)
1880
- _header_accept = ['application/json']
1881
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1882
-
1883
- # HTTP header 'Content-Type'
1884
- _header_content_type = ['application/json']
1885
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1886
-
1887
- # form parameters
1888
- form_params = {}
1889
-
1890
- # http body (model)
1891
- post_body = nil
1892
-
1893
-
1894
- auth_names = ['PureCloud Auth']
1895
- data, status_code, headers = @api_client.call_api(:GET, path,
1896
- :header_params => header_params,
1897
- :query_params => query_params,
1898
- :form_params => form_params,
1899
- :body => post_body,
1900
- :auth_names => auth_names,
1901
- :return_type => 'SystemPrompt')
1902
- if @api_client.config.debugging
1903
- @api_client.config.logger.debug "API called: ArchitectApi#get_systemprompts_prompt_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1904
- end
1905
- return data, status_code, headers
1906
- end
1907
-
1908
- # Get IVR System Prompt resources.
1909
- #
1910
- # @param prompt_id Prompt ID
1911
- # @param [Hash] opts the optional parameters
1912
- # @option opts [Integer] :page_number Page number
1913
- # @option opts [Integer] :page_size Page size
1914
- # @option opts [String] :sort_by Sort by
1915
- # @option opts [String] :sort_order Sort order
1916
- # @return [SystemPromptAssetEntityListing]
1917
- def get_systemprompts_prompt_id_resources(prompt_id, opts = {})
1918
- data, status_code, headers = get_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts)
1919
- return data
1920
- end
1921
-
1922
- # Get IVR System Prompt resources.
1923
- #
1924
- # @param prompt_id Prompt ID
1925
- # @param [Hash] opts the optional parameters
1926
- # @option opts [Integer] :page_number Page number
1927
- # @option opts [Integer] :page_size Page size
1928
- # @option opts [String] :sort_by Sort by
1929
- # @option opts [String] :sort_order Sort order
1930
- # @return [Array<(SystemPromptAssetEntityListing, Fixnum, Hash)>] SystemPromptAssetEntityListing data, response status code and response headers
1931
- def get_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
1932
- if @api_client.config.debugging
1933
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id_resources ..."
1934
- end
1935
-
1936
- # verify the required parameter 'prompt_id' is set
1937
- fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id_resources" if prompt_id.nil?
1938
-
1939
- # resource path
1940
- path = "/api/v2/architect/systemprompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
1941
-
1942
- # query parameters
1943
- query_params = {}
1944
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1945
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1946
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1947
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1948
-
1949
- # header parameters
1950
- header_params = {}
1951
-
1952
- # HTTP header 'Accept' (if needed)
1953
- _header_accept = ['application/json']
1954
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1955
-
1956
- # HTTP header 'Content-Type'
1957
- _header_content_type = ['application/json']
1958
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1959
-
1960
- # form parameters
1961
- form_params = {}
1962
-
1963
- # http body (model)
1964
- post_body = nil
1965
-
1966
-
1967
- auth_names = ['PureCloud Auth']
1968
- data, status_code, headers = @api_client.call_api(:GET, path,
1969
- :header_params => header_params,
1970
- :query_params => query_params,
1971
- :form_params => form_params,
1972
- :body => post_body,
1973
- :auth_names => auth_names,
1974
- :return_type => 'SystemPromptAssetEntityListing')
1975
- if @api_client.config.debugging
1976
- @api_client.config.logger.debug "API called: ArchitectApi#get_systemprompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1977
- end
1978
- return data, status_code, headers
1979
- end
1980
-
1981
- # Create system prompt resource override.
1982
- #
1983
- # @param prompt_id Prompt ID
1984
- # @param [Hash] opts the optional parameters
1985
- # @option opts [SystemPromptAsset] :body
1986
- # @return [SystemPromptAsset]
1987
- def post_systemprompts_prompt_id_resources(prompt_id, opts = {})
1988
- data, status_code, headers = post_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts)
1989
- return data
1990
- end
1991
-
1992
- # Create system prompt resource override.
1993
- #
1994
- # @param prompt_id Prompt ID
1995
- # @param [Hash] opts the optional parameters
1996
- # @option opts [SystemPromptAsset] :body
1997
- # @return [Array<(SystemPromptAsset, Fixnum, Hash)>] SystemPromptAsset data, response status code and response headers
1998
- def post_systemprompts_prompt_id_resources_with_http_info(prompt_id, opts = {})
1999
- if @api_client.config.debugging
2000
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_systemprompts_prompt_id_resources ..."
2001
- end
2002
-
2003
- # verify the required parameter 'prompt_id' is set
2004
- fail "Missing the required parameter 'prompt_id' when calling post_systemprompts_prompt_id_resources" if prompt_id.nil?
2005
-
2006
- # resource path
2007
- path = "/api/v2/architect/systemprompts/{promptId}/resources".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s)
2008
-
2009
- # query parameters
2010
- query_params = {}
2011
-
2012
- # header parameters
2013
- header_params = {}
2014
-
2015
- # HTTP header 'Accept' (if needed)
2016
- _header_accept = ['application/json']
2017
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2018
-
2019
- # HTTP header 'Content-Type'
2020
- _header_content_type = ['application/json']
2021
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2022
-
2023
- # form parameters
2024
- form_params = {}
2025
-
2026
- # http body (model)
2027
- post_body = @api_client.object_to_http_body(opts[:'body'])
2028
-
2029
-
2030
- auth_names = ['PureCloud Auth']
2031
- data, status_code, headers = @api_client.call_api(:POST, path,
2032
- :header_params => header_params,
2033
- :query_params => query_params,
2034
- :form_params => form_params,
2035
- :body => post_body,
2036
- :auth_names => auth_names,
2037
- :return_type => 'SystemPromptAsset')
2038
- if @api_client.config.debugging
2039
- @api_client.config.logger.debug "API called: ArchitectApi#post_systemprompts_prompt_id_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2040
- end
2041
- return data, status_code, headers
2042
- end
2043
-
2044
- # Get a system prompt resource.
2045
- #
2046
- # @param prompt_id Prompt ID
2047
- # @param language Language
2048
- # @param [Hash] opts the optional parameters
2049
- # @return [SystemPromptAsset]
2050
- def get_systemprompts_prompt_id_resources_language(prompt_id, language, opts = {})
2051
- data, status_code, headers = get_systemprompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts)
2052
- return data
2053
- end
2054
-
2055
- # Get a system prompt resource.
2056
- #
2057
- # @param prompt_id Prompt ID
2058
- # @param language Language
2059
- # @param [Hash] opts the optional parameters
2060
- # @return [Array<(SystemPromptAsset, Fixnum, Hash)>] SystemPromptAsset data, response status code and response headers
2061
- def get_systemprompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts = {})
2062
- if @api_client.config.debugging
2063
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_systemprompts_prompt_id_resources_language ..."
2064
- end
2065
-
2066
- # verify the required parameter 'prompt_id' is set
2067
- fail "Missing the required parameter 'prompt_id' when calling get_systemprompts_prompt_id_resources_language" if prompt_id.nil?
2068
-
2069
- # verify the required parameter 'language' is set
2070
- fail "Missing the required parameter 'language' when calling get_systemprompts_prompt_id_resources_language" if language.nil?
2071
-
2072
- # resource path
2073
- path = "/api/v2/architect/systemprompts/{promptId}/resources/{language}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'language' + '}', language.to_s)
2074
-
2075
- # query parameters
2076
- query_params = {}
2077
-
2078
- # header parameters
2079
- header_params = {}
2080
-
2081
- # HTTP header 'Accept' (if needed)
2082
- _header_accept = ['application/json']
2083
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2084
-
2085
- # HTTP header 'Content-Type'
2086
- _header_content_type = ['application/json']
2087
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2088
-
2089
- # form parameters
2090
- form_params = {}
2091
-
2092
- # http body (model)
2093
- post_body = nil
2094
-
2095
-
2096
- auth_names = ['PureCloud Auth']
2097
- data, status_code, headers = @api_client.call_api(:GET, path,
2098
- :header_params => header_params,
2099
- :query_params => query_params,
2100
- :form_params => form_params,
2101
- :body => post_body,
2102
- :auth_names => auth_names,
2103
- :return_type => 'SystemPromptAsset')
2104
- if @api_client.config.debugging
2105
- @api_client.config.logger.debug "API called: ArchitectApi#get_systemprompts_prompt_id_resources_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2106
- end
2107
- return data, status_code, headers
2108
- end
2109
-
2110
- # Delete a system prompt resource override.
2111
- #
2112
- # @param prompt_id Prompt ID
2113
- # @param language Language
2114
- # @param [Hash] opts the optional parameters
2115
- # @return [String]
2116
- def delete_systemprompts_prompt_id_resources_language(prompt_id, language, opts = {})
2117
- data, status_code, headers = delete_systemprompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts)
2118
- return data
2119
- end
2120
-
2121
- # Delete a system prompt resource override.
2122
- #
2123
- # @param prompt_id Prompt ID
2124
- # @param language Language
2125
- # @param [Hash] opts the optional parameters
2126
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
2127
- def delete_systemprompts_prompt_id_resources_language_with_http_info(prompt_id, language, opts = {})
2128
- if @api_client.config.debugging
2129
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_systemprompts_prompt_id_resources_language ..."
2130
- end
2131
-
2132
- # verify the required parameter 'prompt_id' is set
2133
- fail "Missing the required parameter 'prompt_id' when calling delete_systemprompts_prompt_id_resources_language" if prompt_id.nil?
2134
-
2135
- # verify the required parameter 'language' is set
2136
- fail "Missing the required parameter 'language' when calling delete_systemprompts_prompt_id_resources_language" if language.nil?
2137
-
2138
- # resource path
2139
- path = "/api/v2/architect/systemprompts/{promptId}/resources/{language}".sub('{format}','json').sub('{' + 'promptId' + '}', prompt_id.to_s).sub('{' + 'language' + '}', language.to_s)
2140
-
2141
- # query parameters
2142
- query_params = {}
2143
-
2144
- # header parameters
2145
- header_params = {}
2146
-
2147
- # HTTP header 'Accept' (if needed)
2148
- _header_accept = ['application/json']
2149
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2150
-
2151
- # HTTP header 'Content-Type'
2152
- _header_content_type = ['application/json']
2153
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2154
-
2155
- # form parameters
2156
- form_params = {}
2157
-
2158
- # http body (model)
2159
- post_body = nil
2160
-
2161
-
2162
- auth_names = ['PureCloud Auth']
2163
- data, status_code, headers = @api_client.call_api(:DELETE, path,
2164
- :header_params => header_params,
2165
- :query_params => query_params,
2166
- :form_params => form_params,
2167
- :body => post_body,
2168
- :auth_names => auth_names,
2169
- :return_type => 'String')
2170
- if @api_client.config.debugging
2171
- @api_client.config.logger.debug "API called: ArchitectApi#delete_systemprompts_prompt_id_resources_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2172
- end
2173
- return data, status_code, headers
2174
- end
2175
-
2176
- # Get a pageable list of flows, filtered by query parameters
2177
- # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
2178
- # @param [Hash] opts the optional parameters
2179
- # @option opts [String] :type Type
2180
- # @option opts [Integer] :page_number Page number
2181
- # @option opts [Integer] :page_size Page size
2182
- # @option opts [String] :sort_by Sort by
2183
- # @option opts [String] :sort_order Sort order
2184
- # @option opts [Array<String>] :id ID
2185
- # @option opts [String] :name Name
2186
- # @option opts [String] :description Description
2187
- # @option opts [String] :name_or_description Name or description
2188
- # @option opts [String] :publish_version_id Publish version ID
2189
- # @option opts [String] :editable_by Editable by
2190
- # @option opts [String] :locked_by Locked by
2191
- # @option opts [BOOLEAN] :deleted Include deleted
2192
- # @return [FlowEntityListing]
2193
- def get_flows(opts = {})
2194
- data, status_code, headers = get_flows_with_http_info(opts)
2195
- return data
2196
- end
2197
-
2198
- # Get a pageable list of flows, filtered by query parameters
2199
- # Multiple IDs can be specified, in which case all matching flows will be returned, and no other parameters will be evaluated.
2200
- # @param [Hash] opts the optional parameters
2201
- # @option opts [String] :type Type
2202
- # @option opts [Integer] :page_number Page number
2203
- # @option opts [Integer] :page_size Page size
2204
- # @option opts [String] :sort_by Sort by
2205
- # @option opts [String] :sort_order Sort order
2206
- # @option opts [Array<String>] :id ID
2207
- # @option opts [String] :name Name
2208
- # @option opts [String] :description Description
2209
- # @option opts [String] :name_or_description Name or description
2210
- # @option opts [String] :publish_version_id Publish version ID
2211
- # @option opts [String] :editable_by Editable by
2212
- # @option opts [String] :locked_by Locked by
2213
- # @option opts [BOOLEAN] :deleted Include deleted
2214
- # @return [Array<(FlowEntityListing, Fixnum, Hash)>] FlowEntityListing data, response status code and response headers
2215
- def get_flows_with_http_info(opts = {})
2216
- if @api_client.config.debugging
2217
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flows ..."
2218
- end
2219
-
2220
- # resource path
2221
- path = "/api/v2/flows".sub('{format}','json')
2222
-
2223
- # query parameters
2224
- query_params = {}
2225
- query_params[:'type'] = opts[:'type'] if opts[:'type']
2226
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2227
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2228
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2229
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2230
- query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
2231
- query_params[:'name'] = opts[:'name'] if opts[:'name']
2232
- query_params[:'description'] = opts[:'description'] if opts[:'description']
2233
- query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
2234
- query_params[:'publishVersionId'] = opts[:'publish_version_id'] if opts[:'publish_version_id']
2235
- query_params[:'editableBy'] = opts[:'editable_by'] if opts[:'editable_by']
2236
- query_params[:'lockedBy'] = opts[:'locked_by'] if opts[:'locked_by']
2237
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
2238
-
2239
- # header parameters
2240
- header_params = {}
2241
-
2242
- # HTTP header 'Accept' (if needed)
2243
- _header_accept = ['application/json']
2244
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2245
-
2246
- # HTTP header 'Content-Type'
2247
- _header_content_type = ['application/json']
2248
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2249
-
2250
- # form parameters
2251
- form_params = {}
2252
-
2253
- # http body (model)
2254
- post_body = nil
2255
-
2256
-
2257
- auth_names = ['PureCloud Auth']
2258
- data, status_code, headers = @api_client.call_api(:GET, path,
2259
- :header_params => header_params,
2260
- :query_params => query_params,
2261
- :form_params => form_params,
2262
- :body => post_body,
2263
- :auth_names => auth_names,
2264
- :return_type => 'FlowEntityListing')
2265
- if @api_client.config.debugging
2266
- @api_client.config.logger.debug "API called: ArchitectApi#get_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2267
- end
2268
- return data, status_code, headers
2269
- end
2270
-
2271
- # Create flow
2272
- #
2273
- # @param [Hash] opts the optional parameters
2274
- # @option opts [Flow] :body
2275
- # @return [Flow]
2276
- def post_flows(opts = {})
2277
- data, status_code, headers = post_flows_with_http_info(opts)
2278
- return data
2279
- end
2280
-
2281
- # Create flow
2282
- #
2283
- # @param [Hash] opts the optional parameters
2284
- # @option opts [Flow] :body
2285
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2286
- def post_flows_with_http_info(opts = {})
2287
- if @api_client.config.debugging
2288
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_flows ..."
2289
- end
2290
-
2291
- # resource path
2292
- path = "/api/v2/flows".sub('{format}','json')
2293
-
2294
- # query parameters
2295
- query_params = {}
2296
-
2297
- # header parameters
2298
- header_params = {}
2299
-
2300
- # HTTP header 'Accept' (if needed)
2301
- _header_accept = ['application/json']
2302
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2303
-
2304
- # HTTP header 'Content-Type'
2305
- _header_content_type = ['application/json']
2306
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2307
-
2308
- # form parameters
2309
- form_params = {}
2310
-
2311
- # http body (model)
2312
- post_body = @api_client.object_to_http_body(opts[:'body'])
2313
-
2314
-
2315
- auth_names = ['PureCloud Auth']
2316
- data, status_code, headers = @api_client.call_api(:POST, path,
2317
- :header_params => header_params,
2318
- :query_params => query_params,
2319
- :form_params => form_params,
2320
- :body => post_body,
2321
- :auth_names => auth_names,
2322
- :return_type => 'Flow')
2323
- if @api_client.config.debugging
2324
- @api_client.config.logger.debug "API called: ArchitectApi#post_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2325
- end
2326
- return data, status_code, headers
2327
- end
2328
-
2329
- # Batch-delete a list of flows
2330
- # Multiple IDs can be specified, in which case all specified flows will be deleted.
2331
- # @param id List of Flow IDs
2332
- # @param [Hash] opts the optional parameters
2333
- # @option opts [BOOLEAN] :ignore_dependencies Ignore Dependencies
2334
- # @return [nil]
2335
- def delete_flows(id, opts = {})
2336
- delete_flows_with_http_info(id, opts)
2337
- return nil
2338
- end
2339
-
2340
- # Batch-delete a list of flows
2341
- # Multiple IDs can be specified, in which case all specified flows will be deleted.
2342
- # @param id List of Flow IDs
2343
- # @param [Hash] opts the optional parameters
2344
- # @option opts [BOOLEAN] :ignore_dependencies Ignore Dependencies
2345
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2346
- def delete_flows_with_http_info(id, opts = {})
2347
- if @api_client.config.debugging
2348
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_flows ..."
2349
- end
2350
-
2351
- # verify the required parameter 'id' is set
2352
- fail "Missing the required parameter 'id' when calling delete_flows" if id.nil?
2353
-
2354
- # resource path
2355
- path = "/api/v2/flows".sub('{format}','json')
2356
-
2357
- # query parameters
2358
- query_params = {}
2359
- query_params[:'id'] = @api_client.build_collection_param(id, :multi)
2360
- query_params[:'ignoreDependencies'] = opts[:'ignore_dependencies'] if opts[:'ignore_dependencies']
2361
-
2362
- # header parameters
2363
- header_params = {}
2364
-
2365
- # HTTP header 'Accept' (if needed)
2366
- _header_accept = ['application/json']
2367
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2368
-
2369
- # HTTP header 'Content-Type'
2370
- _header_content_type = ['application/json']
2371
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2372
-
2373
- # form parameters
2374
- form_params = {}
2375
-
2376
- # http body (model)
2377
- post_body = nil
2378
-
2379
-
2380
- auth_names = ['PureCloud Auth']
2381
- data, status_code, headers = @api_client.call_api(:DELETE, path,
2382
- :header_params => header_params,
2383
- :query_params => query_params,
2384
- :form_params => form_params,
2385
- :body => post_body,
2386
- :auth_names => auth_names)
2387
- if @api_client.config.debugging
2388
- @api_client.config.logger.debug "API called: ArchitectApi#delete_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2389
- end
2390
- return data, status_code, headers
2391
- end
2392
-
2393
- # Check-in flow
2394
- #
2395
- # @param [Hash] opts the optional parameters
2396
- # @option opts [String] :flow Flow
2397
- # @return [Flow]
2398
- def post_actions_checkin(opts = {})
2399
- data, status_code, headers = post_actions_checkin_with_http_info(opts)
2400
- return data
2401
- end
2402
-
2403
- # Check-in flow
2404
- #
2405
- # @param [Hash] opts the optional parameters
2406
- # @option opts [String] :flow Flow
2407
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2408
- def post_actions_checkin_with_http_info(opts = {})
2409
- if @api_client.config.debugging
2410
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_actions_checkin ..."
2411
- end
2412
-
2413
- # resource path
2414
- path = "/api/v2/flows/actions/checkin".sub('{format}','json')
2415
-
2416
- # query parameters
2417
- query_params = {}
2418
- query_params[:'flow'] = opts[:'flow'] if opts[:'flow']
2419
-
2420
- # header parameters
2421
- header_params = {}
2422
-
2423
- # HTTP header 'Accept' (if needed)
2424
- _header_accept = ['application/json']
2425
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2426
-
2427
- # HTTP header 'Content-Type'
2428
- _header_content_type = ['application/json']
2429
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2430
-
2431
- # form parameters
2432
- form_params = {}
2433
-
2434
- # http body (model)
2435
- post_body = nil
2436
-
2437
-
2438
- auth_names = ['PureCloud Auth']
2439
- data, status_code, headers = @api_client.call_api(:POST, path,
2440
- :header_params => header_params,
2441
- :query_params => query_params,
2442
- :form_params => form_params,
2443
- :body => post_body,
2444
- :auth_names => auth_names,
2445
- :return_type => 'Flow')
2446
- if @api_client.config.debugging
2447
- @api_client.config.logger.debug "API called: ArchitectApi#post_actions_checkin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2448
- end
2449
- return data, status_code, headers
2450
- end
2451
-
2452
- # Check-out flow
2453
- #
2454
- # @param [Hash] opts the optional parameters
2455
- # @option opts [String] :flow Flow
2456
- # @return [Flow]
2457
- def post_actions_checkout(opts = {})
2458
- data, status_code, headers = post_actions_checkout_with_http_info(opts)
2459
- return data
2460
- end
2461
-
2462
- # Check-out flow
2463
- #
2464
- # @param [Hash] opts the optional parameters
2465
- # @option opts [String] :flow Flow
2466
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2467
- def post_actions_checkout_with_http_info(opts = {})
2468
- if @api_client.config.debugging
2469
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_actions_checkout ..."
2470
- end
2471
-
2472
- # resource path
2473
- path = "/api/v2/flows/actions/checkout".sub('{format}','json')
2474
-
2475
- # query parameters
2476
- query_params = {}
2477
- query_params[:'flow'] = opts[:'flow'] if opts[:'flow']
2478
-
2479
- # header parameters
2480
- header_params = {}
2481
-
2482
- # HTTP header 'Accept' (if needed)
2483
- _header_accept = ['application/json']
2484
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2485
-
2486
- # HTTP header 'Content-Type'
2487
- _header_content_type = ['application/json']
2488
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2489
-
2490
- # form parameters
2491
- form_params = {}
2492
-
2493
- # http body (model)
2494
- post_body = nil
2495
-
2496
-
2497
- auth_names = ['PureCloud Auth']
2498
- data, status_code, headers = @api_client.call_api(:POST, path,
2499
- :header_params => header_params,
2500
- :query_params => query_params,
2501
- :form_params => form_params,
2502
- :body => post_body,
2503
- :auth_names => auth_names,
2504
- :return_type => 'Flow')
2505
- if @api_client.config.debugging
2506
- @api_client.config.logger.debug "API called: ArchitectApi#post_actions_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2507
- end
2508
- return data, status_code, headers
2509
- end
2510
-
2511
- # Deactivate flow
2512
- #
2513
- # @param [Hash] opts the optional parameters
2514
- # @option opts [String] :flow Flow
2515
- # @return [Flow]
2516
- def post_actions_deactivate(opts = {})
2517
- data, status_code, headers = post_actions_deactivate_with_http_info(opts)
2518
- return data
2519
- end
2520
-
2521
- # Deactivate flow
2522
- #
2523
- # @param [Hash] opts the optional parameters
2524
- # @option opts [String] :flow Flow
2525
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2526
- def post_actions_deactivate_with_http_info(opts = {})
2527
- if @api_client.config.debugging
2528
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_actions_deactivate ..."
2529
- end
2530
-
2531
- # resource path
2532
- path = "/api/v2/flows/actions/deactivate".sub('{format}','json')
2533
-
2534
- # query parameters
2535
- query_params = {}
2536
- query_params[:'flow'] = opts[:'flow'] if opts[:'flow']
2537
-
2538
- # header parameters
2539
- header_params = {}
2540
-
2541
- # HTTP header 'Accept' (if needed)
2542
- _header_accept = ['application/json']
2543
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2544
-
2545
- # HTTP header 'Content-Type'
2546
- _header_content_type = ['application/json']
2547
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2548
-
2549
- # form parameters
2550
- form_params = {}
2551
-
2552
- # http body (model)
2553
- post_body = nil
2554
-
2555
-
2556
- auth_names = ['PureCloud Auth']
2557
- data, status_code, headers = @api_client.call_api(:POST, path,
2558
- :header_params => header_params,
2559
- :query_params => query_params,
2560
- :form_params => form_params,
2561
- :body => post_body,
2562
- :auth_names => auth_names,
2563
- :return_type => 'Flow')
2564
- if @api_client.config.debugging
2565
- @api_client.config.logger.debug "API called: ArchitectApi#post_actions_deactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2566
- end
2567
- return data, status_code, headers
2568
- end
2569
-
2570
- # Debug flow
2571
- #
2572
- # @param version
2573
- # @param [Hash] opts the optional parameters
2574
- # @option opts [String] :flow Flow
2575
- # @return [nil]
2576
- def post_actions_debug(version, opts = {})
2577
- post_actions_debug_with_http_info(version, opts)
2578
- return nil
2579
- end
2580
-
2581
- # Debug flow
2582
- #
2583
- # @param version
2584
- # @param [Hash] opts the optional parameters
2585
- # @option opts [String] :flow Flow
2586
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2587
- def post_actions_debug_with_http_info(version, opts = {})
2588
- if @api_client.config.debugging
2589
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_actions_debug ..."
2590
- end
2591
-
2592
- # verify the required parameter 'version' is set
2593
- fail "Missing the required parameter 'version' when calling post_actions_debug" if version.nil?
2594
-
2595
- # resource path
2596
- path = "/api/v2/flows/actions/debug".sub('{format}','json')
2597
-
2598
- # query parameters
2599
- query_params = {}
2600
- query_params[:'version'] = version
2601
- query_params[:'flow'] = opts[:'flow'] if opts[:'flow']
2602
-
2603
- # header parameters
2604
- header_params = {}
2605
-
2606
- # HTTP header 'Accept' (if needed)
2607
- _header_accept = ['application/json']
2608
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2609
-
2610
- # HTTP header 'Content-Type'
2611
- _header_content_type = ['application/json']
2612
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2613
-
2614
- # form parameters
2615
- form_params = {}
2616
-
2617
- # http body (model)
2618
- post_body = nil
2619
-
2620
-
2621
- auth_names = ['PureCloud Auth']
2622
- data, status_code, headers = @api_client.call_api(:POST, path,
2623
- :header_params => header_params,
2624
- :query_params => query_params,
2625
- :form_params => form_params,
2626
- :body => post_body,
2627
- :auth_names => auth_names)
2628
- if @api_client.config.debugging
2629
- @api_client.config.logger.debug "API called: ArchitectApi#post_actions_debug\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2630
- end
2631
- return data, status_code, headers
2632
- end
2633
-
2634
- # Revert flow
2635
- #
2636
- # @param [Hash] opts the optional parameters
2637
- # @option opts [String] :flow Flow
2638
- # @return [Flow]
2639
- def post_actions_revert(opts = {})
2640
- data, status_code, headers = post_actions_revert_with_http_info(opts)
2641
- return data
2642
- end
2643
-
2644
- # Revert flow
2645
- #
2646
- # @param [Hash] opts the optional parameters
2647
- # @option opts [String] :flow Flow
2648
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2649
- def post_actions_revert_with_http_info(opts = {})
2650
- if @api_client.config.debugging
2651
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_actions_revert ..."
2652
- end
2653
-
2654
- # resource path
2655
- path = "/api/v2/flows/actions/revert".sub('{format}','json')
2656
-
2657
- # query parameters
2658
- query_params = {}
2659
- query_params[:'flow'] = opts[:'flow'] if opts[:'flow']
2660
-
2661
- # header parameters
2662
- header_params = {}
2663
-
2664
- # HTTP header 'Accept' (if needed)
2665
- _header_accept = ['application/json']
2666
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2667
-
2668
- # HTTP header 'Content-Type'
2669
- _header_content_type = ['application/json']
2670
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2671
-
2672
- # form parameters
2673
- form_params = {}
2674
-
2675
- # http body (model)
2676
- post_body = nil
2677
-
2678
-
2679
- auth_names = ['PureCloud Auth']
2680
- data, status_code, headers = @api_client.call_api(:POST, path,
2681
- :header_params => header_params,
2682
- :query_params => query_params,
2683
- :form_params => form_params,
2684
- :body => post_body,
2685
- :auth_names => auth_names,
2686
- :return_type => 'Flow')
2687
- if @api_client.config.debugging
2688
- @api_client.config.logger.debug "API called: ArchitectApi#post_actions_revert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2689
- end
2690
- return data, status_code, headers
2691
- end
2692
-
2693
- # Get flow.
2694
- #
2695
- # @param flow_id Flow ID
2696
- # @param [Hash] opts the optional parameters
2697
- # @option opts [String] :deleted Deleted
2698
- # @return [Flow]
2699
- def get_flow_id(flow_id, opts = {})
2700
- data, status_code, headers = get_flow_id_with_http_info(flow_id, opts)
2701
- return data
2702
- end
2703
-
2704
- # Get flow.
2705
- #
2706
- # @param flow_id Flow ID
2707
- # @param [Hash] opts the optional parameters
2708
- # @option opts [String] :deleted Deleted
2709
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2710
- def get_flow_id_with_http_info(flow_id, opts = {})
2711
- if @api_client.config.debugging
2712
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id ..."
2713
- end
2714
-
2715
- # verify the required parameter 'flow_id' is set
2716
- fail "Missing the required parameter 'flow_id' when calling get_flow_id" if flow_id.nil?
2717
-
2718
- # resource path
2719
- path = "/api/v2/flows/{flowId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
2720
-
2721
- # query parameters
2722
- query_params = {}
2723
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
2724
-
2725
- # header parameters
2726
- header_params = {}
2727
-
2728
- # HTTP header 'Accept' (if needed)
2729
- _header_accept = ['application/json']
2730
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2731
-
2732
- # HTTP header 'Content-Type'
2733
- _header_content_type = ['application/json']
2734
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2735
-
2736
- # form parameters
2737
- form_params = {}
2738
-
2739
- # http body (model)
2740
- post_body = nil
2741
-
2742
-
2743
- auth_names = ['PureCloud Auth']
2744
- data, status_code, headers = @api_client.call_api(:GET, path,
2745
- :header_params => header_params,
2746
- :query_params => query_params,
2747
- :form_params => form_params,
2748
- :body => post_body,
2749
- :auth_names => auth_names,
2750
- :return_type => 'Flow')
2751
- if @api_client.config.debugging
2752
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2753
- end
2754
- return data, status_code, headers
2755
- end
2756
-
2757
- # Update flow.
2758
- #
2759
- # @param flow_id Flow ID
2760
- # @param [Hash] opts the optional parameters
2761
- # @option opts [Flow] :body
2762
- # @return [Flow]
2763
- def put_flow_id(flow_id, opts = {})
2764
- data, status_code, headers = put_flow_id_with_http_info(flow_id, opts)
2765
- return data
2766
- end
2767
-
2768
- # Update flow.
2769
- #
2770
- # @param flow_id Flow ID
2771
- # @param [Hash] opts the optional parameters
2772
- # @option opts [Flow] :body
2773
- # @return [Array<(Flow, Fixnum, Hash)>] Flow data, response status code and response headers
2774
- def put_flow_id_with_http_info(flow_id, opts = {})
2775
- if @api_client.config.debugging
2776
- @api_client.config.logger.debug "Calling API: ArchitectApi#put_flow_id ..."
2777
- end
2778
-
2779
- # verify the required parameter 'flow_id' is set
2780
- fail "Missing the required parameter 'flow_id' when calling put_flow_id" if flow_id.nil?
2781
-
2782
- # resource path
2783
- path = "/api/v2/flows/{flowId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
2784
-
2785
- # query parameters
2786
- query_params = {}
2787
-
2788
- # header parameters
2789
- header_params = {}
2790
-
2791
- # HTTP header 'Accept' (if needed)
2792
- _header_accept = ['application/json']
2793
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2794
-
2795
- # HTTP header 'Content-Type'
2796
- _header_content_type = ['application/json']
2797
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2798
-
2799
- # form parameters
2800
- form_params = {}
2801
-
2802
- # http body (model)
2803
- post_body = @api_client.object_to_http_body(opts[:'body'])
2804
-
2805
-
2806
- auth_names = ['PureCloud Auth']
2807
- data, status_code, headers = @api_client.call_api(:PUT, path,
2808
- :header_params => header_params,
2809
- :query_params => query_params,
2810
- :form_params => form_params,
2811
- :body => post_body,
2812
- :auth_names => auth_names,
2813
- :return_type => 'Flow')
2814
- if @api_client.config.debugging
2815
- @api_client.config.logger.debug "API called: ArchitectApi#put_flow_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2816
- end
2817
- return data, status_code, headers
2818
- end
2819
-
2820
- # Delete flow.
2821
- #
2822
- # @param flow_id Flow ID
2823
- # @param [Hash] opts the optional parameters
2824
- # @return [nil]
2825
- def delete_flow_id(flow_id, opts = {})
2826
- delete_flow_id_with_http_info(flow_id, opts)
2827
- return nil
2828
- end
2829
-
2830
- # Delete flow.
2831
- #
2832
- # @param flow_id Flow ID
2833
- # @param [Hash] opts the optional parameters
2834
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2835
- def delete_flow_id_with_http_info(flow_id, opts = {})
2836
- if @api_client.config.debugging
2837
- @api_client.config.logger.debug "Calling API: ArchitectApi#delete_flow_id ..."
2838
- end
2839
-
2840
- # verify the required parameter 'flow_id' is set
2841
- fail "Missing the required parameter 'flow_id' when calling delete_flow_id" if flow_id.nil?
2842
-
2843
- # resource path
2844
- path = "/api/v2/flows/{flowId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
2845
-
2846
- # query parameters
2847
- query_params = {}
2848
-
2849
- # header parameters
2850
- header_params = {}
2851
-
2852
- # HTTP header 'Accept' (if needed)
2853
- _header_accept = ['application/json']
2854
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2855
-
2856
- # HTTP header 'Content-Type'
2857
- _header_content_type = ['application/json']
2858
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2859
-
2860
- # form parameters
2861
- form_params = {}
2862
-
2863
- # http body (model)
2864
- post_body = nil
2865
-
2866
-
2867
- auth_names = ['PureCloud Auth']
2868
- data, status_code, headers = @api_client.call_api(:DELETE, path,
2869
- :header_params => header_params,
2870
- :query_params => query_params,
2871
- :form_params => form_params,
2872
- :body => post_body,
2873
- :auth_names => auth_names)
2874
- if @api_client.config.debugging
2875
- @api_client.config.logger.debug "API called: ArchitectApi#delete_flow_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2876
- end
2877
- return data, status_code, headers
2878
- end
2879
-
2880
- # Get the latest configuration for flow.
2881
- #
2882
- # @param flow_id Flow ID
2883
- # @param [Hash] opts the optional parameters
2884
- # @option opts [String] :deleted Deleted
2885
- # @return [inline_response_200]
2886
- def get_flow_id_latestconfiguration(flow_id, opts = {})
2887
- data, status_code, headers = get_flow_id_latestconfiguration_with_http_info(flow_id, opts)
2888
- return data
2889
- end
2890
-
2891
- # Get the latest configuration for flow.
2892
- #
2893
- # @param flow_id Flow ID
2894
- # @param [Hash] opts the optional parameters
2895
- # @option opts [String] :deleted Deleted
2896
- # @return [Array<(inline_response_200, Fixnum, Hash)>] inline_response_200 data, response status code and response headers
2897
- def get_flow_id_latestconfiguration_with_http_info(flow_id, opts = {})
2898
- if @api_client.config.debugging
2899
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id_latestconfiguration ..."
2900
- end
2901
-
2902
- # verify the required parameter 'flow_id' is set
2903
- fail "Missing the required parameter 'flow_id' when calling get_flow_id_latestconfiguration" if flow_id.nil?
2904
-
2905
- # resource path
2906
- path = "/api/v2/flows/{flowId}/latestconfiguration".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
2907
-
2908
- # query parameters
2909
- query_params = {}
2910
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
2911
-
2912
- # header parameters
2913
- header_params = {}
2914
-
2915
- # HTTP header 'Accept' (if needed)
2916
- _header_accept = ['application/json']
2917
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2918
-
2919
- # HTTP header 'Content-Type'
2920
- _header_content_type = ['application/json']
2921
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2922
-
2923
- # form parameters
2924
- form_params = {}
2925
-
2926
- # http body (model)
2927
- post_body = nil
2928
-
2929
-
2930
- auth_names = ['PureCloud Auth']
2931
- data, status_code, headers = @api_client.call_api(:GET, path,
2932
- :header_params => header_params,
2933
- :query_params => query_params,
2934
- :form_params => form_params,
2935
- :body => post_body,
2936
- :auth_names => auth_names,
2937
- :return_type => 'inline_response_200')
2938
- if @api_client.config.debugging
2939
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id_latestconfiguration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2940
- end
2941
- return data, status_code, headers
2942
- end
2943
-
2944
- # Get generation result.
2945
- #
2946
- # @param flow_id Flow ID
2947
- # @param id Publish Result ID
2948
- # @param [Hash] opts the optional parameters
2949
- # @return [PublishedResult]
2950
- def get_flow_id_publishedresults_id(flow_id, id, opts = {})
2951
- data, status_code, headers = get_flow_id_publishedresults_id_with_http_info(flow_id, id, opts)
2952
- return data
2953
- end
2954
-
2955
- # Get generation result.
2956
- #
2957
- # @param flow_id Flow ID
2958
- # @param id Publish Result ID
2959
- # @param [Hash] opts the optional parameters
2960
- # @return [Array<(PublishedResult, Fixnum, Hash)>] PublishedResult data, response status code and response headers
2961
- def get_flow_id_publishedresults_id_with_http_info(flow_id, id, opts = {})
2962
- if @api_client.config.debugging
2963
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id_publishedresults_id ..."
2964
- end
2965
-
2966
- # verify the required parameter 'flow_id' is set
2967
- fail "Missing the required parameter 'flow_id' when calling get_flow_id_publishedresults_id" if flow_id.nil?
2968
-
2969
- # verify the required parameter 'id' is set
2970
- fail "Missing the required parameter 'id' when calling get_flow_id_publishedresults_id" if id.nil?
2971
-
2972
- # resource path
2973
- path = "/api/v2/flows/{flowId}/publishedresults/{id}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'id' + '}', id.to_s)
2974
-
2975
- # query parameters
2976
- query_params = {}
2977
-
2978
- # header parameters
2979
- header_params = {}
2980
-
2981
- # HTTP header 'Accept' (if needed)
2982
- _header_accept = ['application/json']
2983
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2984
-
2985
- # HTTP header 'Content-Type'
2986
- _header_content_type = ['application/json']
2987
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2988
-
2989
- # form parameters
2990
- form_params = {}
2991
-
2992
- # http body (model)
2993
- post_body = nil
2994
-
2995
-
2996
- auth_names = ['PureCloud Auth']
2997
- data, status_code, headers = @api_client.call_api(:GET, path,
2998
- :header_params => header_params,
2999
- :query_params => query_params,
3000
- :form_params => form_params,
3001
- :body => post_body,
3002
- :auth_names => auth_names,
3003
- :return_type => 'PublishedResult')
3004
- if @api_client.config.debugging
3005
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id_publishedresults_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3006
- end
3007
- return data, status_code, headers
3008
- end
3009
-
3010
- # Get flow version list
3011
- #
3012
- # @param flow_id Flow ID
3013
- # @param [Hash] opts the optional parameters
3014
- # @option opts [Integer] :page_number Page number
3015
- # @option opts [Integer] :page_size Page size
3016
- # @option opts [String] :deleted Deleted
3017
- # @return [FlowVersionEntityListing]
3018
- def get_flow_id_versions(flow_id, opts = {})
3019
- data, status_code, headers = get_flow_id_versions_with_http_info(flow_id, opts)
3020
- return data
3021
- end
3022
-
3023
- # Get flow version list
3024
- #
3025
- # @param flow_id Flow ID
3026
- # @param [Hash] opts the optional parameters
3027
- # @option opts [Integer] :page_number Page number
3028
- # @option opts [Integer] :page_size Page size
3029
- # @option opts [String] :deleted Deleted
3030
- # @return [Array<(FlowVersionEntityListing, Fixnum, Hash)>] FlowVersionEntityListing data, response status code and response headers
3031
- def get_flow_id_versions_with_http_info(flow_id, opts = {})
3032
- if @api_client.config.debugging
3033
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id_versions ..."
3034
- end
3035
-
3036
- # verify the required parameter 'flow_id' is set
3037
- fail "Missing the required parameter 'flow_id' when calling get_flow_id_versions" if flow_id.nil?
3038
-
3039
- # resource path
3040
- path = "/api/v2/flows/{flowId}/versions".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
3041
-
3042
- # query parameters
3043
- query_params = {}
3044
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
3045
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3046
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
3047
-
3048
- # header parameters
3049
- header_params = {}
3050
-
3051
- # HTTP header 'Accept' (if needed)
3052
- _header_accept = ['application/json']
3053
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
3054
-
3055
- # HTTP header 'Content-Type'
3056
- _header_content_type = ['application/json']
3057
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
3058
-
3059
- # form parameters
3060
- form_params = {}
3061
-
3062
- # http body (model)
3063
- post_body = nil
3064
-
3065
-
3066
- auth_names = ['PureCloud Auth']
3067
- data, status_code, headers = @api_client.call_api(:GET, path,
3068
- :header_params => header_params,
3069
- :query_params => query_params,
3070
- :form_params => form_params,
3071
- :body => post_body,
3072
- :auth_names => auth_names,
3073
- :return_type => 'FlowVersionEntityListing')
3074
- if @api_client.config.debugging
3075
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3076
- end
3077
- return data, status_code, headers
3078
- end
3079
-
3080
- # Create flow version
3081
- #
3082
- # @param flow_id Flow ID
3083
- # @param [Hash] opts the optional parameters
3084
- # @option opts [Body] :body
3085
- # @return [FlowVersion]
3086
- def post_flow_id_versions(flow_id, opts = {})
3087
- data, status_code, headers = post_flow_id_versions_with_http_info(flow_id, opts)
3088
- return data
3089
- end
3090
-
3091
- # Create flow version
3092
- #
3093
- # @param flow_id Flow ID
3094
- # @param [Hash] opts the optional parameters
3095
- # @option opts [Body] :body
3096
- # @return [Array<(FlowVersion, Fixnum, Hash)>] FlowVersion data, response status code and response headers
3097
- def post_flow_id_versions_with_http_info(flow_id, opts = {})
3098
- if @api_client.config.debugging
3099
- @api_client.config.logger.debug "Calling API: ArchitectApi#post_flow_id_versions ..."
3100
- end
3101
-
3102
- # verify the required parameter 'flow_id' is set
3103
- fail "Missing the required parameter 'flow_id' when calling post_flow_id_versions" if flow_id.nil?
3104
-
3105
- # resource path
3106
- path = "/api/v2/flows/{flowId}/versions".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s)
3107
-
3108
- # query parameters
3109
- query_params = {}
3110
-
3111
- # header parameters
3112
- header_params = {}
3113
-
3114
- # HTTP header 'Accept' (if needed)
3115
- _header_accept = ['application/json']
3116
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
3117
-
3118
- # HTTP header 'Content-Type'
3119
- _header_content_type = ['application/json']
3120
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
3121
-
3122
- # form parameters
3123
- form_params = {}
3124
-
3125
- # http body (model)
3126
- post_body = @api_client.object_to_http_body(opts[:'body'])
3127
-
3128
-
3129
- auth_names = ['PureCloud Auth']
3130
- data, status_code, headers = @api_client.call_api(:POST, path,
3131
- :header_params => header_params,
3132
- :query_params => query_params,
3133
- :form_params => form_params,
3134
- :body => post_body,
3135
- :auth_names => auth_names,
3136
- :return_type => 'FlowVersion')
3137
- if @api_client.config.debugging
3138
- @api_client.config.logger.debug "API called: ArchitectApi#post_flow_id_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3139
- end
3140
- return data, status_code, headers
3141
- end
3142
-
3143
- # Get flow version
3144
- #
3145
- # @param flow_id Flow ID
3146
- # @param version_id Version ID
3147
- # @param [Hash] opts the optional parameters
3148
- # @option opts [String] :deleted Deleted
3149
- # @return [FlowVersion]
3150
- def get_flow_id_versions_version_id(flow_id, version_id, opts = {})
3151
- data, status_code, headers = get_flow_id_versions_version_id_with_http_info(flow_id, version_id, opts)
3152
- return data
3153
- end
3154
-
3155
- # Get flow version
3156
- #
3157
- # @param flow_id Flow ID
3158
- # @param version_id Version ID
3159
- # @param [Hash] opts the optional parameters
3160
- # @option opts [String] :deleted Deleted
3161
- # @return [Array<(FlowVersion, Fixnum, Hash)>] FlowVersion data, response status code and response headers
3162
- def get_flow_id_versions_version_id_with_http_info(flow_id, version_id, opts = {})
3163
- if @api_client.config.debugging
3164
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id_versions_version_id ..."
3165
- end
3166
-
3167
- # verify the required parameter 'flow_id' is set
3168
- fail "Missing the required parameter 'flow_id' when calling get_flow_id_versions_version_id" if flow_id.nil?
3169
-
3170
- # verify the required parameter 'version_id' is set
3171
- fail "Missing the required parameter 'version_id' when calling get_flow_id_versions_version_id" if version_id.nil?
3172
-
3173
- # resource path
3174
- path = "/api/v2/flows/{flowId}/versions/{versionId}".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
3175
-
3176
- # query parameters
3177
- query_params = {}
3178
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
3179
-
3180
- # header parameters
3181
- header_params = {}
3182
-
3183
- # HTTP header 'Accept' (if needed)
3184
- _header_accept = ['application/json']
3185
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
3186
-
3187
- # HTTP header 'Content-Type'
3188
- _header_content_type = ['application/json']
3189
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
3190
-
3191
- # form parameters
3192
- form_params = {}
3193
-
3194
- # http body (model)
3195
- post_body = nil
3196
-
3197
-
3198
- auth_names = ['PureCloud Auth']
3199
- data, status_code, headers = @api_client.call_api(:GET, path,
3200
- :header_params => header_params,
3201
- :query_params => query_params,
3202
- :form_params => form_params,
3203
- :body => post_body,
3204
- :auth_names => auth_names,
3205
- :return_type => 'FlowVersion')
3206
- if @api_client.config.debugging
3207
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id_versions_version_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3208
- end
3209
- return data, status_code, headers
3210
- end
3211
-
3212
- # Create flow version configuration
3213
- #
3214
- # @param flow_id Flow ID
3215
- # @param version_id Version ID
3216
- # @param [Hash] opts the optional parameters
3217
- # @option opts [String] :deleted Deleted
3218
- # @return [inline_response_200]
3219
- def get_flow_id_versions_version_id_configuration(flow_id, version_id, opts = {})
3220
- data, status_code, headers = get_flow_id_versions_version_id_configuration_with_http_info(flow_id, version_id, opts)
3221
- return data
3222
- end
3223
-
3224
- # Create flow version configuration
3225
- #
3226
- # @param flow_id Flow ID
3227
- # @param version_id Version ID
3228
- # @param [Hash] opts the optional parameters
3229
- # @option opts [String] :deleted Deleted
3230
- # @return [Array<(inline_response_200, Fixnum, Hash)>] inline_response_200 data, response status code and response headers
3231
- def get_flow_id_versions_version_id_configuration_with_http_info(flow_id, version_id, opts = {})
3232
- if @api_client.config.debugging
3233
- @api_client.config.logger.debug "Calling API: ArchitectApi#get_flow_id_versions_version_id_configuration ..."
3234
- end
3235
-
3236
- # verify the required parameter 'flow_id' is set
3237
- fail "Missing the required parameter 'flow_id' when calling get_flow_id_versions_version_id_configuration" if flow_id.nil?
3238
-
3239
- # verify the required parameter 'version_id' is set
3240
- fail "Missing the required parameter 'version_id' when calling get_flow_id_versions_version_id_configuration" if version_id.nil?
3241
-
3242
- # resource path
3243
- path = "/api/v2/flows/{flowId}/versions/{versionId}/configuration".sub('{format}','json').sub('{' + 'flowId' + '}', flow_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
3244
-
3245
- # query parameters
3246
- query_params = {}
3247
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
3248
-
3249
- # header parameters
3250
- header_params = {}
3251
-
3252
- # HTTP header 'Accept' (if needed)
3253
- _header_accept = ['application/json']
3254
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
3255
-
3256
- # HTTP header 'Content-Type'
3257
- _header_content_type = ['application/json']
3258
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
3259
-
3260
- # form parameters
3261
- form_params = {}
3262
-
3263
- # http body (model)
3264
- post_body = nil
3265
-
3266
-
3267
- auth_names = ['PureCloud Auth']
3268
- data, status_code, headers = @api_client.call_api(:GET, path,
3269
- :header_params => header_params,
3270
- :query_params => query_params,
3271
- :form_params => form_params,
3272
- :body => post_body,
3273
- :auth_names => auth_names,
3274
- :return_type => 'inline_response_200')
3275
- if @api_client.config.debugging
3276
- @api_client.config.logger.debug "API called: ArchitectApi#get_flow_id_versions_version_id_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3277
- end
3278
- return data, status_code, headers
3279
- end
3280
- end
3281
- end
3282
-
3283
-
3284
-
3285
-