purecloud 0.27.0 → 0.28.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (269) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -0
  3. data/config-ruby.json +1 -1
  4. data/extensions/auth.rb +7 -0
  5. data/lib/purecloud.rb +137 -85
  6. data/lib/purecloud/api/analytics_api.rb +1906 -0
  7. data/lib/purecloud/api/architect_api.rb +51 -51
  8. data/lib/purecloud/api/attributes_api.rb +6 -6
  9. data/lib/purecloud/api/authorization_api.rb +17 -79
  10. data/lib/purecloud/api/callbacks_api.rb +483 -0
  11. data/lib/purecloud/api/calls_api.rb +1088 -0
  12. data/lib/purecloud/api/chats_api.rb +483 -0
  13. data/lib/purecloud/api/compliance_api.rb +2 -2
  14. data/lib/purecloud/api/configuration_api.rb +83 -83
  15. data/lib/purecloud/api/content_management_api.rb +36 -36
  16. data/lib/purecloud/api/conversations_api.rb +3542 -465
  17. data/lib/purecloud/api/downloads_api.rb +2 -2
  18. data/lib/purecloud/api/emails_api.rb +1013 -0
  19. data/lib/purecloud/api/evaluations_api.rb +73 -0
  20. data/lib/purecloud/api/external_contacts_api.rb +26 -26
  21. data/lib/purecloud/api/fax_api.rb +6 -6
  22. data/lib/purecloud/api/faxes_api.rb +73 -0
  23. data/lib/purecloud/api/geolocation_api.rb +4 -4
  24. data/lib/purecloud/api/greetings_api.rb +12 -12
  25. data/lib/purecloud/api/groups_api.rb +3 -3
  26. data/lib/purecloud/api/integrations_api.rb +144 -0
  27. data/lib/purecloud/api/languages_api.rb +2 -2
  28. data/lib/purecloud/api/licensing_api.rb +7 -7
  29. data/lib/purecloud/api/locations_api.rb +2 -2
  30. data/lib/purecloud/api/notifications_api.rb +7 -7
  31. data/lib/purecloud/api/o_auth_api.rb +22 -22
  32. data/lib/purecloud/api/outbound_api.rb +69 -81
  33. data/lib/purecloud/api/presence_api.rb +10 -10
  34. data/lib/purecloud/api/quality_api.rb +41 -93
  35. data/lib/purecloud/api/recording_api.rb +20 -29
  36. data/lib/purecloud/api/response_management_api.rb +11 -11
  37. data/lib/purecloud/api/routing_api.rb +333 -189
  38. data/lib/purecloud/api/scripts_api.rb +11 -11
  39. data/lib/purecloud/api/search_api.rb +1 -1
  40. data/lib/purecloud/api/socials_api.rb +483 -0
  41. data/lib/purecloud/api/stations_api.rb +3 -3
  42. data/lib/purecloud/api/telephony_providers_edge_api.rb +38 -38
  43. data/lib/purecloud/api/tokens_api.rb +1 -1
  44. data/lib/purecloud/api/user_recordings_api.rb +6 -6
  45. data/lib/purecloud/api/users_api.rb +403 -95
  46. data/lib/purecloud/api/utilities_api.rb +4 -60
  47. data/lib/purecloud/api/videos_api.rb +483 -0
  48. data/lib/purecloud/api/voicemail_api.rb +11 -11
  49. data/lib/purecloud/models/address.rb +47 -25
  50. data/lib/purecloud/models/address_listing.rb +11 -11
  51. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  52. data/lib/purecloud/models/aggregate_data_container.rb +161 -0
  53. data/lib/purecloud/models/aggregate_metric_data.rb +175 -0
  54. data/lib/purecloud/models/{session_request.rb → aggregate_query_response.rb} +10 -8
  55. data/lib/purecloud/models/{domain_license_entity_listing.rb → aggregation_query.rb} +49 -79
  56. data/lib/purecloud/models/{tag.rb → aggregation_range.rb} +16 -16
  57. data/lib/purecloud/models/aggregation_result.rb +199 -0
  58. data/lib/purecloud/models/aggregation_result_entry.rb +179 -0
  59. data/lib/purecloud/models/alert_entity_listing.rb +11 -11
  60. data/lib/purecloud/models/analytics_conversation.rb +181 -0
  61. data/lib/purecloud/models/analytics_conversation_query_response.rb +160 -0
  62. data/lib/purecloud/models/{queue_member_entity_listing.rb → analytics_evaluation.rb} +62 -64
  63. data/lib/purecloud/models/analytics_participant.rb +158 -0
  64. data/lib/purecloud/models/analytics_property.rb +178 -0
  65. data/lib/purecloud/models/analytics_query_aggregation.rb +202 -0
  66. data/lib/purecloud/models/analytics_query_clause.rb +168 -0
  67. data/lib/purecloud/models/analytics_query_filter.rb +181 -0
  68. data/lib/purecloud/models/analytics_query_predicate.rb +269 -0
  69. data/lib/purecloud/models/analytics_segment.rb +607 -0
  70. data/lib/purecloud/models/{put_management_unit.rb → analytics_session.rb} +27 -25
  71. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  72. data/lib/purecloud/models/audit_entity_reference.rb +1 -1
  73. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +11 -11
  74. data/lib/purecloud/models/available_additional_service_listing.rb +11 -11
  75. data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
  76. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  77. data/lib/purecloud/models/call.rb +2 -22
  78. data/lib/purecloud/models/call_conversation.rb +213 -0
  79. data/lib/purecloud/models/call_participant.rb +527 -0
  80. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  81. data/lib/purecloud/models/callback_conversation.rb +194 -0
  82. data/lib/purecloud/models/callback_participant.rb +456 -0
  83. data/lib/purecloud/models/campaign.rb +17 -219
  84. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  85. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  86. data/lib/purecloud/models/carrier_entity_listing.rb +11 -11
  87. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  88. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  89. data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
  90. data/lib/purecloud/models/{domain_license.rb → chat_conversation.rb} +19 -25
  91. data/lib/purecloud/models/chat_participant.rb +270 -12
  92. data/lib/purecloud/models/chat_search_listing.rb +11 -11
  93. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  94. data/lib/purecloud/models/consumed_resources_entity_listing.rb +11 -11
  95. data/lib/purecloud/models/consuming_resources_entity_listing.rb +11 -11
  96. data/lib/purecloud/models/contact.rb +41 -73
  97. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  98. data/lib/purecloud/models/contact_listing.rb +11 -11
  99. data/lib/purecloud/models/contact_sales.rb +1 -21
  100. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  101. data/lib/purecloud/models/{evaluation_query_request.rb → conversation_query.rb} +77 -90
  102. data/lib/purecloud/models/conversation_query_response.rb +11 -11
  103. data/lib/purecloud/models/{session_entity_listing.rb → create_call_request.rb} +71 -68
  104. data/lib/purecloud/models/{conversation_response.rb → create_call_response.rb} +1 -1
  105. data/lib/purecloud/models/create_user.rb +219 -0
  106. data/lib/purecloud/models/data_item.rb +19 -23
  107. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +11 -11
  108. data/lib/purecloud/models/dependency_object_entity_listing.rb +11 -11
  109. data/lib/purecloud/models/dependency_type_entity_listing.rb +11 -11
  110. data/lib/purecloud/models/destination.rb +1 -21
  111. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  112. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  113. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  114. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  115. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  116. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +11 -11
  117. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  118. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  119. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  120. data/lib/purecloud/models/domain_invoice_entity_listing.rb +11 -11
  121. data/lib/purecloud/models/domain_organization_role.rb +1 -23
  122. data/lib/purecloud/models/domain_permission.rb +1 -13
  123. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +11 -11
  124. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +11 -11
  125. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +11 -11
  126. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +11 -11
  127. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +11 -11
  128. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  129. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  130. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  131. data/lib/purecloud/models/email_conversation.rb +194 -0
  132. data/lib/purecloud/models/email_message_listing.rb +11 -11
  133. data/lib/purecloud/models/email_participant.rb +424 -0
  134. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  135. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  136. data/lib/purecloud/models/entity.rb +10 -20
  137. data/lib/purecloud/models/evaluation.rb +1 -0
  138. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  139. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  140. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  141. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  142. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  143. data/lib/purecloud/models/external_organization_listing.rb +11 -11
  144. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/filter.rb +14 -11
  146. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/flow_entity_listing.rb +11 -11
  148. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +11 -11
  149. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +11 -11
  150. data/lib/purecloud/models/flow_version_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/hardware_rate_listing.rb +11 -11
  153. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  154. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  155. data/lib/purecloud/models/integration_type_entity_listing.rb +11 -11
  156. data/lib/purecloud/models/ivr_entity_listing.rb +11 -11
  157. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  158. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  160. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  161. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +11 -11
  162. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +11 -11
  163. data/lib/purecloud/models/location_entity_listing.rb +11 -11
  164. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  165. data/lib/purecloud/models/management_unit.rb +26 -14
  166. data/lib/purecloud/models/media_result.rb +1 -11
  167. data/lib/purecloud/models/media_summary.rb +2 -2
  168. data/lib/purecloud/models/media_summary_detail.rb +156 -0
  169. data/lib/purecloud/models/note_listing.rb +11 -11
  170. data/lib/purecloud/models/numeric_range.rb +180 -0
  171. data/lib/purecloud/models/o_auth_client.rb +21 -14
  172. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  173. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  174. data/lib/purecloud/models/observation_data_container.rb +161 -0
  175. data/lib/purecloud/models/observation_query.rb +160 -0
  176. data/lib/purecloud/models/observation_query_response.rb +148 -0
  177. data/lib/purecloud/models/okta.rb +11 -11
  178. data/lib/purecloud/models/one_login.rb +11 -11
  179. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  180. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  182. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  183. data/lib/purecloud/models/paging_spec.rb +158 -0
  184. data/lib/purecloud/models/participant.rb +1 -13
  185. data/lib/purecloud/models/payment_method_listing.rb +11 -11
  186. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  188. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  189. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  190. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  191. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  192. data/lib/purecloud/models/presence_query_response.rb +161 -0
  193. data/lib/purecloud/models/prompt_asset_entity_listing.rb +11 -11
  194. data/lib/purecloud/models/prompt_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/property_index_request.rb +182 -0
  196. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  197. data/lib/purecloud/models/queue.rb +1 -23
  198. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  199. data/lib/purecloud/models/queues_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/quote.rb +1 -37
  201. data/lib/purecloud/models/quote_listing.rb +11 -11
  202. data/lib/purecloud/models/recording.rb +13 -34
  203. data/lib/purecloud/models/relationship_listing.rb +11 -11
  204. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  205. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  206. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  207. data/lib/purecloud/models/response.rb +14 -84
  208. data/lib/purecloud/models/response_entity_list.rb +11 -11
  209. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  210. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  211. data/lib/purecloud/models/{user_status.rb → routing_skill.rb} +35 -25
  212. data/lib/purecloud/models/rule_entity_listing.rb +11 -11
  213. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/salesforce.rb +11 -11
  215. data/lib/purecloud/models/schedule_entity_listing.rb +11 -11
  216. data/lib/purecloud/models/schedule_group_entity_listing.rb +11 -11
  217. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  219. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  220. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/service_entity_listing.rb +11 -11
  222. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/skill_entity_listing.rb +12 -12
  225. data/lib/purecloud/models/social_conversation.rb +194 -0
  226. data/lib/purecloud/models/social_participant.rb +446 -0
  227. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +11 -11
  228. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  229. data/lib/purecloud/models/statistical_response.rb +158 -0
  230. data/lib/purecloud/models/statistical_summary.rb +226 -0
  231. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +11 -11
  232. data/lib/purecloud/models/system_prompt_entity_listing.rb +11 -11
  233. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/template_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/text_table_transform_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/time_zone.rb +1 -11
  237. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  238. data/lib/purecloud/models/transfer_request.rb +193 -0
  239. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/user.rb +96 -129
  241. data/lib/purecloud/models/user_action_category_entity_listing.rb +11 -11
  242. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  243. data/lib/purecloud/models/user_authorization.rb +1 -13
  244. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  245. data/lib/purecloud/models/user_presence_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/user_queue.rb +1 -23
  247. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  248. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  249. data/lib/purecloud/models/{session.rb → user_routing_skill.rb} +26 -41
  250. data/lib/purecloud/models/user_skill_entity_listing.rb +12 -12
  251. data/lib/purecloud/models/user_station.rb +178 -0
  252. data/lib/purecloud/models/user_stations.rb +180 -0
  253. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  254. data/lib/purecloud/models/utilization.rb +4 -36
  255. data/lib/purecloud/models/video_conversation.rb +194 -0
  256. data/lib/purecloud/models/video_participant.rb +463 -0
  257. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +11 -11
  258. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +11 -11
  259. data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
  260. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  263. data/lib/purecloud/version.rb +1 -1
  264. data/newVersion.md +1 -1
  265. data/swagger.json +1 -1
  266. data/version.json +1 -1
  267. metadata +60 -15
  268. data/lib/purecloud/models/skill.rb +0 -269
  269. data/lib/purecloud/models/user_skill.rb +0 -290
@@ -31,7 +31,7 @@ module PureCloud
31
31
  end
32
32
 
33
33
  # resource path
34
- path = "/api/v1/downloads/callback".sub('{format}','json')
34
+ path = "/api/v2/downloads/callback".sub('{format}','json')
35
35
 
36
36
  # query parameters
37
37
  query_params = {}
@@ -95,7 +95,7 @@ module PureCloud
95
95
  fail "Missing the required parameter 'download_id' when calling get_download_id" if download_id.nil?
96
96
 
97
97
  # resource path
98
- path = "/api/v1/downloads/{downloadId}".sub('{format}','json').sub('{' + 'downloadId' + '}', download_id.to_s)
98
+ path = "/api/v2/downloads/{downloadId}".sub('{format}','json').sub('{' + 'downloadId' + '}', download_id.to_s)
99
99
 
100
100
  # query parameters
101
101
  query_params = {}
@@ -0,0 +1,1013 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class EmailsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get conversations
12
+ #
13
+ # @param attachment_id attachment ID
14
+ # @param message_id message ID
15
+ # @param conversation_id conversation ID
16
+ # @param participant_id participant ID
17
+ # @param [Hash] opts the optional parameters
18
+ # @return [ConversationEntityListing]
19
+ def get_emails(attachment_id, message_id, conversation_id, participant_id, opts = {})
20
+ data, status_code, headers = get_emails_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
21
+ return data
22
+ end
23
+
24
+ # Get conversations
25
+ #
26
+ # @param attachment_id attachment ID
27
+ # @param message_id message ID
28
+ # @param conversation_id conversation ID
29
+ # @param participant_id participant ID
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [Array<(ConversationEntityListing, Fixnum, Hash)>] ConversationEntityListing data, response status code and response headers
32
+ def get_emails_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
33
+ if @api_client.config.debugging
34
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_emails ..."
35
+ end
36
+
37
+ # verify the required parameter 'attachment_id' is set
38
+ fail "Missing the required parameter 'attachment_id' when calling get_emails" if attachment_id.nil?
39
+
40
+ # verify the required parameter 'message_id' is set
41
+ fail "Missing the required parameter 'message_id' when calling get_emails" if message_id.nil?
42
+
43
+ # verify the required parameter 'conversation_id' is set
44
+ fail "Missing the required parameter 'conversation_id' when calling get_emails" if conversation_id.nil?
45
+
46
+ # verify the required parameter 'participant_id' is set
47
+ fail "Missing the required parameter 'participant_id' when calling get_emails" if participant_id.nil?
48
+
49
+ # resource path
50
+ path = "/api/v2/emails".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
51
+
52
+ # query parameters
53
+ query_params = {}
54
+
55
+ # header parameters
56
+ header_params = {}
57
+
58
+ # HTTP header 'Accept' (if needed)
59
+ _header_accept = ['application/json']
60
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
61
+
62
+ # HTTP header 'Content-Type'
63
+ _header_content_type = ['application/json']
64
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
65
+
66
+ # form parameters
67
+ form_params = {}
68
+
69
+ # http body (model)
70
+ post_body = nil
71
+
72
+
73
+ auth_names = ['PureCloud Auth']
74
+ data, status_code, headers = @api_client.call_api(:GET, path,
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => 'ConversationEntityListing')
81
+ if @api_client.config.debugging
82
+ @api_client.config.logger.debug "API called: EmailsApi#get_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
+ end
84
+ return data, status_code, headers
85
+ end
86
+
87
+ # Update conversation participant
88
+ #
89
+ # @param attachment_id attachment ID
90
+ # @param message_id message ID
91
+ # @param conversation_id conversation ID
92
+ # @param participant_id participant ID
93
+ # @param [Hash] opts the optional parameters
94
+ # @option opts [ParticipantRequest] :body
95
+ # @return [nil]
96
+ def patch_participants_participant_id(attachment_id, message_id, conversation_id, participant_id, opts = {})
97
+ patch_participants_participant_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
98
+ return nil
99
+ end
100
+
101
+ # Update conversation participant
102
+ #
103
+ # @param attachment_id attachment ID
104
+ # @param message_id message ID
105
+ # @param conversation_id conversation ID
106
+ # @param participant_id participant ID
107
+ # @param [Hash] opts the optional parameters
108
+ # @option opts [ParticipantRequest] :body
109
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
110
+ def patch_participants_participant_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
111
+ if @api_client.config.debugging
112
+ @api_client.config.logger.debug "Calling API: EmailsApi#patch_participants_participant_id ..."
113
+ end
114
+
115
+ # verify the required parameter 'attachment_id' is set
116
+ fail "Missing the required parameter 'attachment_id' when calling patch_participants_participant_id" if attachment_id.nil?
117
+
118
+ # verify the required parameter 'message_id' is set
119
+ fail "Missing the required parameter 'message_id' when calling patch_participants_participant_id" if message_id.nil?
120
+
121
+ # verify the required parameter 'conversation_id' is set
122
+ fail "Missing the required parameter 'conversation_id' when calling patch_participants_participant_id" if conversation_id.nil?
123
+
124
+ # verify the required parameter 'participant_id' is set
125
+ fail "Missing the required parameter 'participant_id' when calling patch_participants_participant_id" if participant_id.nil?
126
+
127
+ # resource path
128
+ path = "/api/v2/emails/participants/{participantId}".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
129
+
130
+ # query parameters
131
+ query_params = {}
132
+
133
+ # header parameters
134
+ header_params = {}
135
+
136
+ # HTTP header 'Accept' (if needed)
137
+ _header_accept = ['application/json']
138
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
139
+
140
+ # HTTP header 'Content-Type'
141
+ _header_content_type = ['application/json']
142
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
143
+
144
+ # form parameters
145
+ form_params = {}
146
+
147
+ # http body (model)
148
+ post_body = @api_client.object_to_http_body(opts[:'body'])
149
+
150
+
151
+ auth_names = ['PureCloud Auth']
152
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
153
+ :header_params => header_params,
154
+ :query_params => query_params,
155
+ :form_params => form_params,
156
+ :body => post_body,
157
+ :auth_names => auth_names)
158
+ if @api_client.config.debugging
159
+ @api_client.config.logger.debug "API called: EmailsApi#patch_participants_participant_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
160
+ end
161
+ return data, status_code, headers
162
+ end
163
+
164
+ # Update the attributes on a conversation participant.
165
+ #
166
+ # @param attachment_id attachment ID
167
+ # @param message_id message ID
168
+ # @param conversation_id conversation ID
169
+ # @param participant_id participant ID
170
+ # @param [Hash] opts the optional parameters
171
+ # @option opts [ParticipantAttributes] :body
172
+ # @return [nil]
173
+ def patch_participants_participant_id_attributes(attachment_id, message_id, conversation_id, participant_id, opts = {})
174
+ patch_participants_participant_id_attributes_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
175
+ return nil
176
+ end
177
+
178
+ # Update the attributes on a conversation participant.
179
+ #
180
+ # @param attachment_id attachment ID
181
+ # @param message_id message ID
182
+ # @param conversation_id conversation ID
183
+ # @param participant_id participant ID
184
+ # @param [Hash] opts the optional parameters
185
+ # @option opts [ParticipantAttributes] :body
186
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
187
+ def patch_participants_participant_id_attributes_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
188
+ if @api_client.config.debugging
189
+ @api_client.config.logger.debug "Calling API: EmailsApi#patch_participants_participant_id_attributes ..."
190
+ end
191
+
192
+ # verify the required parameter 'attachment_id' is set
193
+ fail "Missing the required parameter 'attachment_id' when calling patch_participants_participant_id_attributes" if attachment_id.nil?
194
+
195
+ # verify the required parameter 'message_id' is set
196
+ fail "Missing the required parameter 'message_id' when calling patch_participants_participant_id_attributes" if message_id.nil?
197
+
198
+ # verify the required parameter 'conversation_id' is set
199
+ fail "Missing the required parameter 'conversation_id' when calling patch_participants_participant_id_attributes" if conversation_id.nil?
200
+
201
+ # verify the required parameter 'participant_id' is set
202
+ fail "Missing the required parameter 'participant_id' when calling patch_participants_participant_id_attributes" if participant_id.nil?
203
+
204
+ # resource path
205
+ path = "/api/v2/emails/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
206
+
207
+ # query parameters
208
+ query_params = {}
209
+
210
+ # header parameters
211
+ header_params = {}
212
+
213
+ # HTTP header 'Accept' (if needed)
214
+ _header_accept = ['application/json']
215
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
216
+
217
+ # HTTP header 'Content-Type'
218
+ _header_content_type = ['application/json']
219
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
220
+
221
+ # form parameters
222
+ form_params = {}
223
+
224
+ # http body (model)
225
+ post_body = @api_client.object_to_http_body(opts[:'body'])
226
+
227
+
228
+ auth_names = ['PureCloud Auth']
229
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
230
+ :header_params => header_params,
231
+ :query_params => query_params,
232
+ :form_params => form_params,
233
+ :body => post_body,
234
+ :auth_names => auth_names)
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug "API called: EmailsApi#patch_participants_participant_id_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
237
+ end
238
+ return data, status_code, headers
239
+ end
240
+
241
+ # Replace this participant with the specified user and/or address
242
+ #
243
+ # @param attachment_id attachment ID
244
+ # @param message_id message ID
245
+ # @param conversation_id conversation ID
246
+ # @param participant_id participant ID
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [TransferRequest] :body
249
+ # @return [nil]
250
+ def post_participants_participant_id_replace(attachment_id, message_id, conversation_id, participant_id, opts = {})
251
+ post_participants_participant_id_replace_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
252
+ return nil
253
+ end
254
+
255
+ # Replace this participant with the specified user and/or address
256
+ #
257
+ # @param attachment_id attachment ID
258
+ # @param message_id message ID
259
+ # @param conversation_id conversation ID
260
+ # @param participant_id participant ID
261
+ # @param [Hash] opts the optional parameters
262
+ # @option opts [TransferRequest] :body
263
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
264
+ def post_participants_participant_id_replace_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "Calling API: EmailsApi#post_participants_participant_id_replace ..."
267
+ end
268
+
269
+ # verify the required parameter 'attachment_id' is set
270
+ fail "Missing the required parameter 'attachment_id' when calling post_participants_participant_id_replace" if attachment_id.nil?
271
+
272
+ # verify the required parameter 'message_id' is set
273
+ fail "Missing the required parameter 'message_id' when calling post_participants_participant_id_replace" if message_id.nil?
274
+
275
+ # verify the required parameter 'conversation_id' is set
276
+ fail "Missing the required parameter 'conversation_id' when calling post_participants_participant_id_replace" if conversation_id.nil?
277
+
278
+ # verify the required parameter 'participant_id' is set
279
+ fail "Missing the required parameter 'participant_id' when calling post_participants_participant_id_replace" if participant_id.nil?
280
+
281
+ # resource path
282
+ path = "/api/v2/emails/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
283
+
284
+ # query parameters
285
+ query_params = {}
286
+
287
+ # header parameters
288
+ header_params = {}
289
+
290
+ # HTTP header 'Accept' (if needed)
291
+ _header_accept = ['application/json']
292
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
293
+
294
+ # HTTP header 'Content-Type'
295
+ _header_content_type = ['application/json']
296
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
297
+
298
+ # form parameters
299
+ form_params = {}
300
+
301
+ # http body (model)
302
+ post_body = @api_client.object_to_http_body(opts[:'body'])
303
+
304
+
305
+ auth_names = ['PureCloud Auth']
306
+ data, status_code, headers = @api_client.call_api(:POST, path,
307
+ :header_params => header_params,
308
+ :query_params => query_params,
309
+ :form_params => form_params,
310
+ :body => post_body,
311
+ :auth_names => auth_names)
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug "API called: EmailsApi#post_participants_participant_id_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
+ end
315
+ return data, status_code, headers
316
+ end
317
+
318
+ # Get the wrap-up for this conversation participant.
319
+ #
320
+ # @param attachment_id attachment ID
321
+ # @param message_id message ID
322
+ # @param conversation_id conversation ID
323
+ # @param participant_id participant ID
324
+ # @param [Hash] opts the optional parameters
325
+ # @option opts [BOOLEAN] :provisional Indicates if the wrap-up code is provisional.
326
+ # @return [WrapupCode]
327
+ def get_participants_participant_id_wrapup(attachment_id, message_id, conversation_id, participant_id, opts = {})
328
+ data, status_code, headers = get_participants_participant_id_wrapup_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
329
+ return data
330
+ end
331
+
332
+ # Get the wrap-up for this conversation participant.
333
+ #
334
+ # @param attachment_id attachment ID
335
+ # @param message_id message ID
336
+ # @param conversation_id conversation ID
337
+ # @param participant_id participant ID
338
+ # @param [Hash] opts the optional parameters
339
+ # @option opts [BOOLEAN] :provisional Indicates if the wrap-up code is provisional.
340
+ # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
341
+ def get_participants_participant_id_wrapup_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
342
+ if @api_client.config.debugging
343
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_participants_participant_id_wrapup ..."
344
+ end
345
+
346
+ # verify the required parameter 'attachment_id' is set
347
+ fail "Missing the required parameter 'attachment_id' when calling get_participants_participant_id_wrapup" if attachment_id.nil?
348
+
349
+ # verify the required parameter 'message_id' is set
350
+ fail "Missing the required parameter 'message_id' when calling get_participants_participant_id_wrapup" if message_id.nil?
351
+
352
+ # verify the required parameter 'conversation_id' is set
353
+ fail "Missing the required parameter 'conversation_id' when calling get_participants_participant_id_wrapup" if conversation_id.nil?
354
+
355
+ # verify the required parameter 'participant_id' is set
356
+ fail "Missing the required parameter 'participant_id' when calling get_participants_participant_id_wrapup" if participant_id.nil?
357
+
358
+ # resource path
359
+ path = "/api/v2/emails/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
360
+
361
+ # query parameters
362
+ query_params = {}
363
+ query_params[:'provisional'] = opts[:'provisional'] if opts[:'provisional']
364
+
365
+ # header parameters
366
+ header_params = {}
367
+
368
+ # HTTP header 'Accept' (if needed)
369
+ _header_accept = ['application/json']
370
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
371
+
372
+ # HTTP header 'Content-Type'
373
+ _header_content_type = ['application/json']
374
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
375
+
376
+ # form parameters
377
+ form_params = {}
378
+
379
+ # http body (model)
380
+ post_body = nil
381
+
382
+
383
+ auth_names = ['PureCloud Auth']
384
+ data, status_code, headers = @api_client.call_api(:GET, path,
385
+ :header_params => header_params,
386
+ :query_params => query_params,
387
+ :form_params => form_params,
388
+ :body => post_body,
389
+ :auth_names => auth_names,
390
+ :return_type => 'WrapupCode')
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug "API called: EmailsApi#get_participants_participant_id_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
393
+ end
394
+ return data, status_code, headers
395
+ end
396
+
397
+ # Get list of wrapup codes for this conversation participant
398
+ #
399
+ # @param attachment_id attachment ID
400
+ # @param message_id message ID
401
+ # @param conversation_id conversation ID
402
+ # @param participant_id participant ID
403
+ # @param [Hash] opts the optional parameters
404
+ # @return [WrapupCode]
405
+ def get_participants_participant_id_wrapupcodes(attachment_id, message_id, conversation_id, participant_id, opts = {})
406
+ data, status_code, headers = get_participants_participant_id_wrapupcodes_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
407
+ return data
408
+ end
409
+
410
+ # Get list of wrapup codes for this conversation participant
411
+ #
412
+ # @param attachment_id attachment ID
413
+ # @param message_id message ID
414
+ # @param conversation_id conversation ID
415
+ # @param participant_id participant ID
416
+ # @param [Hash] opts the optional parameters
417
+ # @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
418
+ def get_participants_participant_id_wrapupcodes_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
419
+ if @api_client.config.debugging
420
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_participants_participant_id_wrapupcodes ..."
421
+ end
422
+
423
+ # verify the required parameter 'attachment_id' is set
424
+ fail "Missing the required parameter 'attachment_id' when calling get_participants_participant_id_wrapupcodes" if attachment_id.nil?
425
+
426
+ # verify the required parameter 'message_id' is set
427
+ fail "Missing the required parameter 'message_id' when calling get_participants_participant_id_wrapupcodes" if message_id.nil?
428
+
429
+ # verify the required parameter 'conversation_id' is set
430
+ fail "Missing the required parameter 'conversation_id' when calling get_participants_participant_id_wrapupcodes" if conversation_id.nil?
431
+
432
+ # verify the required parameter 'participant_id' is set
433
+ fail "Missing the required parameter 'participant_id' when calling get_participants_participant_id_wrapupcodes" if participant_id.nil?
434
+
435
+ # resource path
436
+ path = "/api/v2/emails/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
437
+
438
+ # query parameters
439
+ query_params = {}
440
+
441
+ # header parameters
442
+ header_params = {}
443
+
444
+ # HTTP header 'Accept' (if needed)
445
+ _header_accept = ['application/json']
446
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
447
+
448
+ # HTTP header 'Content-Type'
449
+ _header_content_type = ['application/json']
450
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
451
+
452
+ # form parameters
453
+ form_params = {}
454
+
455
+ # http body (model)
456
+ post_body = nil
457
+
458
+
459
+ auth_names = ['PureCloud Auth']
460
+ data, status_code, headers = @api_client.call_api(:GET, path,
461
+ :header_params => header_params,
462
+ :query_params => query_params,
463
+ :form_params => form_params,
464
+ :body => post_body,
465
+ :auth_names => auth_names,
466
+ :return_type => 'WrapupCode')
467
+ if @api_client.config.debugging
468
+ @api_client.config.logger.debug "API called: EmailsApi#get_participants_participant_id_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
469
+ end
470
+ return data, status_code, headers
471
+ end
472
+
473
+ # Get email conversation
474
+ #
475
+ # @param attachment_id attachment ID
476
+ # @param message_id message ID
477
+ # @param conversation_id conversation ID
478
+ # @param participant_id participant ID
479
+ # @param [Hash] opts the optional parameters
480
+ # @return [EmailConversation]
481
+ def get_conversation_id(attachment_id, message_id, conversation_id, participant_id, opts = {})
482
+ data, status_code, headers = get_conversation_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
483
+ return data
484
+ end
485
+
486
+ # Get email conversation
487
+ #
488
+ # @param attachment_id attachment ID
489
+ # @param message_id message ID
490
+ # @param conversation_id conversation ID
491
+ # @param participant_id participant ID
492
+ # @param [Hash] opts the optional parameters
493
+ # @return [Array<(EmailConversation, Fixnum, Hash)>] EmailConversation data, response status code and response headers
494
+ def get_conversation_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
495
+ if @api_client.config.debugging
496
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_conversation_id ..."
497
+ end
498
+
499
+ # verify the required parameter 'attachment_id' is set
500
+ fail "Missing the required parameter 'attachment_id' when calling get_conversation_id" if attachment_id.nil?
501
+
502
+ # verify the required parameter 'message_id' is set
503
+ fail "Missing the required parameter 'message_id' when calling get_conversation_id" if message_id.nil?
504
+
505
+ # verify the required parameter 'conversation_id' is set
506
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id" if conversation_id.nil?
507
+
508
+ # verify the required parameter 'participant_id' is set
509
+ fail "Missing the required parameter 'participant_id' when calling get_conversation_id" if participant_id.nil?
510
+
511
+ # resource path
512
+ path = "/api/v2/emails/{conversationId}".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
513
+
514
+ # query parameters
515
+ query_params = {}
516
+
517
+ # header parameters
518
+ header_params = {}
519
+
520
+ # HTTP header 'Accept' (if needed)
521
+ _header_accept = ['application/json']
522
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
523
+
524
+ # HTTP header 'Content-Type'
525
+ _header_content_type = ['application/json']
526
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
527
+
528
+ # form parameters
529
+ form_params = {}
530
+
531
+ # http body (model)
532
+ post_body = nil
533
+
534
+
535
+ auth_names = ['PureCloud Auth']
536
+ data, status_code, headers = @api_client.call_api(:GET, path,
537
+ :header_params => header_params,
538
+ :query_params => query_params,
539
+ :form_params => form_params,
540
+ :body => post_body,
541
+ :auth_names => auth_names,
542
+ :return_type => 'EmailConversation')
543
+ if @api_client.config.debugging
544
+ @api_client.config.logger.debug "API called: EmailsApi#get_conversation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
545
+ end
546
+ return data, status_code, headers
547
+ end
548
+
549
+ # Get conversation messages
550
+ #
551
+ # @param attachment_id attachment ID
552
+ # @param message_id message ID
553
+ # @param conversation_id conversation ID
554
+ # @param participant_id participant ID
555
+ # @param [Hash] opts the optional parameters
556
+ # @return [EmailMessageListing]
557
+ def get_conversation_id_messages(attachment_id, message_id, conversation_id, participant_id, opts = {})
558
+ data, status_code, headers = get_conversation_id_messages_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
559
+ return data
560
+ end
561
+
562
+ # Get conversation messages
563
+ #
564
+ # @param attachment_id attachment ID
565
+ # @param message_id message ID
566
+ # @param conversation_id conversation ID
567
+ # @param participant_id participant ID
568
+ # @param [Hash] opts the optional parameters
569
+ # @return [Array<(EmailMessageListing, Fixnum, Hash)>] EmailMessageListing data, response status code and response headers
570
+ def get_conversation_id_messages_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
571
+ if @api_client.config.debugging
572
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_conversation_id_messages ..."
573
+ end
574
+
575
+ # verify the required parameter 'attachment_id' is set
576
+ fail "Missing the required parameter 'attachment_id' when calling get_conversation_id_messages" if attachment_id.nil?
577
+
578
+ # verify the required parameter 'message_id' is set
579
+ fail "Missing the required parameter 'message_id' when calling get_conversation_id_messages" if message_id.nil?
580
+
581
+ # verify the required parameter 'conversation_id' is set
582
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_messages" if conversation_id.nil?
583
+
584
+ # verify the required parameter 'participant_id' is set
585
+ fail "Missing the required parameter 'participant_id' when calling get_conversation_id_messages" if participant_id.nil?
586
+
587
+ # resource path
588
+ path = "/api/v2/emails/{conversationId}/messages".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
589
+
590
+ # query parameters
591
+ query_params = {}
592
+
593
+ # header parameters
594
+ header_params = {}
595
+
596
+ # HTTP header 'Accept' (if needed)
597
+ _header_accept = ['application/json']
598
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
599
+
600
+ # HTTP header 'Content-Type'
601
+ _header_content_type = ['application/json']
602
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
603
+
604
+ # form parameters
605
+ form_params = {}
606
+
607
+ # http body (model)
608
+ post_body = nil
609
+
610
+
611
+ auth_names = ['PureCloud Auth']
612
+ data, status_code, headers = @api_client.call_api(:GET, path,
613
+ :header_params => header_params,
614
+ :query_params => query_params,
615
+ :form_params => form_params,
616
+ :body => post_body,
617
+ :auth_names => auth_names,
618
+ :return_type => 'EmailMessageListing')
619
+ if @api_client.config.debugging
620
+ @api_client.config.logger.debug "API called: EmailsApi#get_conversation_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
621
+ end
622
+ return data, status_code, headers
623
+ end
624
+
625
+ # Send an email reply
626
+ #
627
+ # @param attachment_id attachment ID
628
+ # @param message_id message ID
629
+ # @param conversation_id conversation ID
630
+ # @param participant_id participant ID
631
+ # @param [Hash] opts the optional parameters
632
+ # @option opts [EmailMessage] :body Reply
633
+ # @return [EmailMessage]
634
+ def post_conversation_id_messages(attachment_id, message_id, conversation_id, participant_id, opts = {})
635
+ data, status_code, headers = post_conversation_id_messages_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
636
+ return data
637
+ end
638
+
639
+ # Send an email reply
640
+ #
641
+ # @param attachment_id attachment ID
642
+ # @param message_id message ID
643
+ # @param conversation_id conversation ID
644
+ # @param participant_id participant ID
645
+ # @param [Hash] opts the optional parameters
646
+ # @option opts [EmailMessage] :body Reply
647
+ # @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
648
+ def post_conversation_id_messages_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
649
+ if @api_client.config.debugging
650
+ @api_client.config.logger.debug "Calling API: EmailsApi#post_conversation_id_messages ..."
651
+ end
652
+
653
+ # verify the required parameter 'attachment_id' is set
654
+ fail "Missing the required parameter 'attachment_id' when calling post_conversation_id_messages" if attachment_id.nil?
655
+
656
+ # verify the required parameter 'message_id' is set
657
+ fail "Missing the required parameter 'message_id' when calling post_conversation_id_messages" if message_id.nil?
658
+
659
+ # verify the required parameter 'conversation_id' is set
660
+ fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_messages" if conversation_id.nil?
661
+
662
+ # verify the required parameter 'participant_id' is set
663
+ fail "Missing the required parameter 'participant_id' when calling post_conversation_id_messages" if participant_id.nil?
664
+
665
+ # resource path
666
+ path = "/api/v2/emails/{conversationId}/messages".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
667
+
668
+ # query parameters
669
+ query_params = {}
670
+
671
+ # header parameters
672
+ header_params = {}
673
+
674
+ # HTTP header 'Accept' (if needed)
675
+ _header_accept = ['application/json']
676
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
677
+
678
+ # HTTP header 'Content-Type'
679
+ _header_content_type = ['application/json']
680
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
681
+
682
+ # form parameters
683
+ form_params = {}
684
+
685
+ # http body (model)
686
+ post_body = @api_client.object_to_http_body(opts[:'body'])
687
+
688
+
689
+ auth_names = ['PureCloud Auth']
690
+ data, status_code, headers = @api_client.call_api(:POST, path,
691
+ :header_params => header_params,
692
+ :query_params => query_params,
693
+ :form_params => form_params,
694
+ :body => post_body,
695
+ :auth_names => auth_names,
696
+ :return_type => 'EmailMessage')
697
+ if @api_client.config.debugging
698
+ @api_client.config.logger.debug "API called: EmailsApi#post_conversation_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ end
700
+ return data, status_code, headers
701
+ end
702
+
703
+ # Get conversation draft reply
704
+ #
705
+ # @param attachment_id attachment ID
706
+ # @param message_id message ID
707
+ # @param conversation_id conversation ID
708
+ # @param participant_id participant ID
709
+ # @param [Hash] opts the optional parameters
710
+ # @return [EmailMessage]
711
+ def get_conversation_id_messages_draft(attachment_id, message_id, conversation_id, participant_id, opts = {})
712
+ data, status_code, headers = get_conversation_id_messages_draft_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
713
+ return data
714
+ end
715
+
716
+ # Get conversation draft reply
717
+ #
718
+ # @param attachment_id attachment ID
719
+ # @param message_id message ID
720
+ # @param conversation_id conversation ID
721
+ # @param participant_id participant ID
722
+ # @param [Hash] opts the optional parameters
723
+ # @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
724
+ def get_conversation_id_messages_draft_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
725
+ if @api_client.config.debugging
726
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_conversation_id_messages_draft ..."
727
+ end
728
+
729
+ # verify the required parameter 'attachment_id' is set
730
+ fail "Missing the required parameter 'attachment_id' when calling get_conversation_id_messages_draft" if attachment_id.nil?
731
+
732
+ # verify the required parameter 'message_id' is set
733
+ fail "Missing the required parameter 'message_id' when calling get_conversation_id_messages_draft" if message_id.nil?
734
+
735
+ # verify the required parameter 'conversation_id' is set
736
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_messages_draft" if conversation_id.nil?
737
+
738
+ # verify the required parameter 'participant_id' is set
739
+ fail "Missing the required parameter 'participant_id' when calling get_conversation_id_messages_draft" if participant_id.nil?
740
+
741
+ # resource path
742
+ path = "/api/v2/emails/{conversationId}/messages/draft".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
743
+
744
+ # query parameters
745
+ query_params = {}
746
+
747
+ # header parameters
748
+ header_params = {}
749
+
750
+ # HTTP header 'Accept' (if needed)
751
+ _header_accept = ['application/json']
752
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
753
+
754
+ # HTTP header 'Content-Type'
755
+ _header_content_type = ['application/json']
756
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
757
+
758
+ # form parameters
759
+ form_params = {}
760
+
761
+ # http body (model)
762
+ post_body = nil
763
+
764
+
765
+ auth_names = ['PureCloud Auth']
766
+ data, status_code, headers = @api_client.call_api(:GET, path,
767
+ :header_params => header_params,
768
+ :query_params => query_params,
769
+ :form_params => form_params,
770
+ :body => post_body,
771
+ :auth_names => auth_names,
772
+ :return_type => 'EmailMessage')
773
+ if @api_client.config.debugging
774
+ @api_client.config.logger.debug "API called: EmailsApi#get_conversation_id_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
775
+ end
776
+ return data, status_code, headers
777
+ end
778
+
779
+ # Update conversation draft reply
780
+ #
781
+ # @param attachment_id attachment ID
782
+ # @param message_id message ID
783
+ # @param conversation_id conversation ID
784
+ # @param participant_id participant ID
785
+ # @param [Hash] opts the optional parameters
786
+ # @option opts [EmailMessage] :body Draft
787
+ # @return [EmailMessage]
788
+ def put_conversation_id_messages_draft(attachment_id, message_id, conversation_id, participant_id, opts = {})
789
+ data, status_code, headers = put_conversation_id_messages_draft_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
790
+ return data
791
+ end
792
+
793
+ # Update conversation draft reply
794
+ #
795
+ # @param attachment_id attachment ID
796
+ # @param message_id message ID
797
+ # @param conversation_id conversation ID
798
+ # @param participant_id participant ID
799
+ # @param [Hash] opts the optional parameters
800
+ # @option opts [EmailMessage] :body Draft
801
+ # @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
802
+ def put_conversation_id_messages_draft_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
803
+ if @api_client.config.debugging
804
+ @api_client.config.logger.debug "Calling API: EmailsApi#put_conversation_id_messages_draft ..."
805
+ end
806
+
807
+ # verify the required parameter 'attachment_id' is set
808
+ fail "Missing the required parameter 'attachment_id' when calling put_conversation_id_messages_draft" if attachment_id.nil?
809
+
810
+ # verify the required parameter 'message_id' is set
811
+ fail "Missing the required parameter 'message_id' when calling put_conversation_id_messages_draft" if message_id.nil?
812
+
813
+ # verify the required parameter 'conversation_id' is set
814
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_messages_draft" if conversation_id.nil?
815
+
816
+ # verify the required parameter 'participant_id' is set
817
+ fail "Missing the required parameter 'participant_id' when calling put_conversation_id_messages_draft" if participant_id.nil?
818
+
819
+ # resource path
820
+ path = "/api/v2/emails/{conversationId}/messages/draft".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
821
+
822
+ # query parameters
823
+ query_params = {}
824
+
825
+ # header parameters
826
+ header_params = {}
827
+
828
+ # HTTP header 'Accept' (if needed)
829
+ _header_accept = ['application/json']
830
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
831
+
832
+ # HTTP header 'Content-Type'
833
+ _header_content_type = ['application/json']
834
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
835
+
836
+ # form parameters
837
+ form_params = {}
838
+
839
+ # http body (model)
840
+ post_body = @api_client.object_to_http_body(opts[:'body'])
841
+
842
+
843
+ auth_names = ['PureCloud Auth']
844
+ data, status_code, headers = @api_client.call_api(:PUT, path,
845
+ :header_params => header_params,
846
+ :query_params => query_params,
847
+ :form_params => form_params,
848
+ :body => post_body,
849
+ :auth_names => auth_names,
850
+ :return_type => 'EmailMessage')
851
+ if @api_client.config.debugging
852
+ @api_client.config.logger.debug "API called: EmailsApi#put_conversation_id_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
853
+ end
854
+ return data, status_code, headers
855
+ end
856
+
857
+ # Delete attachment from draft
858
+ #
859
+ # @param attachment_id attachment ID
860
+ # @param message_id message ID
861
+ # @param conversation_id conversation ID
862
+ # @param participant_id participant ID
863
+ # @param [Hash] opts the optional parameters
864
+ # @return [String]
865
+ def delete_conversation_id_messages_draft_attachments_attachment_id(attachment_id, message_id, conversation_id, participant_id, opts = {})
866
+ data, status_code, headers = delete_conversation_id_messages_draft_attachments_attachment_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
867
+ return data
868
+ end
869
+
870
+ # Delete attachment from draft
871
+ #
872
+ # @param attachment_id attachment ID
873
+ # @param message_id message ID
874
+ # @param conversation_id conversation ID
875
+ # @param participant_id participant ID
876
+ # @param [Hash] opts the optional parameters
877
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
878
+ def delete_conversation_id_messages_draft_attachments_attachment_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
879
+ if @api_client.config.debugging
880
+ @api_client.config.logger.debug "Calling API: EmailsApi#delete_conversation_id_messages_draft_attachments_attachment_id ..."
881
+ end
882
+
883
+ # verify the required parameter 'attachment_id' is set
884
+ fail "Missing the required parameter 'attachment_id' when calling delete_conversation_id_messages_draft_attachments_attachment_id" if attachment_id.nil?
885
+
886
+ # verify the required parameter 'message_id' is set
887
+ fail "Missing the required parameter 'message_id' when calling delete_conversation_id_messages_draft_attachments_attachment_id" if message_id.nil?
888
+
889
+ # verify the required parameter 'conversation_id' is set
890
+ fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_messages_draft_attachments_attachment_id" if conversation_id.nil?
891
+
892
+ # verify the required parameter 'participant_id' is set
893
+ fail "Missing the required parameter 'participant_id' when calling delete_conversation_id_messages_draft_attachments_attachment_id" if participant_id.nil?
894
+
895
+ # resource path
896
+ path = "/api/v2/emails/{conversationId}/messages/draft/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
897
+
898
+ # query parameters
899
+ query_params = {}
900
+
901
+ # header parameters
902
+ header_params = {}
903
+
904
+ # HTTP header 'Accept' (if needed)
905
+ _header_accept = ['application/json']
906
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
907
+
908
+ # HTTP header 'Content-Type'
909
+ _header_content_type = ['application/json']
910
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
911
+
912
+ # form parameters
913
+ form_params = {}
914
+
915
+ # http body (model)
916
+ post_body = nil
917
+
918
+
919
+ auth_names = ['PureCloud Auth']
920
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
921
+ :header_params => header_params,
922
+ :query_params => query_params,
923
+ :form_params => form_params,
924
+ :body => post_body,
925
+ :auth_names => auth_names,
926
+ :return_type => 'String')
927
+ if @api_client.config.debugging
928
+ @api_client.config.logger.debug "API called: EmailsApi#delete_conversation_id_messages_draft_attachments_attachment_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
929
+ end
930
+ return data, status_code, headers
931
+ end
932
+
933
+ # Get conversation message
934
+ #
935
+ # @param attachment_id attachment ID
936
+ # @param message_id message ID
937
+ # @param conversation_id conversation ID
938
+ # @param participant_id participant ID
939
+ # @param [Hash] opts the optional parameters
940
+ # @return [EmailMessage]
941
+ def get_conversation_id_messages_message_id(attachment_id, message_id, conversation_id, participant_id, opts = {})
942
+ data, status_code, headers = get_conversation_id_messages_message_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts)
943
+ return data
944
+ end
945
+
946
+ # Get conversation message
947
+ #
948
+ # @param attachment_id attachment ID
949
+ # @param message_id message ID
950
+ # @param conversation_id conversation ID
951
+ # @param participant_id participant ID
952
+ # @param [Hash] opts the optional parameters
953
+ # @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
954
+ def get_conversation_id_messages_message_id_with_http_info(attachment_id, message_id, conversation_id, participant_id, opts = {})
955
+ if @api_client.config.debugging
956
+ @api_client.config.logger.debug "Calling API: EmailsApi#get_conversation_id_messages_message_id ..."
957
+ end
958
+
959
+ # verify the required parameter 'attachment_id' is set
960
+ fail "Missing the required parameter 'attachment_id' when calling get_conversation_id_messages_message_id" if attachment_id.nil?
961
+
962
+ # verify the required parameter 'message_id' is set
963
+ fail "Missing the required parameter 'message_id' when calling get_conversation_id_messages_message_id" if message_id.nil?
964
+
965
+ # verify the required parameter 'conversation_id' is set
966
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_messages_message_id" if conversation_id.nil?
967
+
968
+ # verify the required parameter 'participant_id' is set
969
+ fail "Missing the required parameter 'participant_id' when calling get_conversation_id_messages_message_id" if participant_id.nil?
970
+
971
+ # resource path
972
+ path = "/api/v2/emails/{conversationId}/messages/{messageId}".sub('{format}','json').sub('{' + 'attachmentId' + '}', attachment_id.to_s).sub('{' + 'messageId' + '}', message_id.to_s).sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
973
+
974
+ # query parameters
975
+ query_params = {}
976
+
977
+ # header parameters
978
+ header_params = {}
979
+
980
+ # HTTP header 'Accept' (if needed)
981
+ _header_accept = ['application/json']
982
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
983
+
984
+ # HTTP header 'Content-Type'
985
+ _header_content_type = ['application/json']
986
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
987
+
988
+ # form parameters
989
+ form_params = {}
990
+
991
+ # http body (model)
992
+ post_body = nil
993
+
994
+
995
+ auth_names = ['PureCloud Auth']
996
+ data, status_code, headers = @api_client.call_api(:GET, path,
997
+ :header_params => header_params,
998
+ :query_params => query_params,
999
+ :form_params => form_params,
1000
+ :body => post_body,
1001
+ :auth_names => auth_names,
1002
+ :return_type => 'EmailMessage')
1003
+ if @api_client.config.debugging
1004
+ @api_client.config.logger.debug "API called: EmailsApi#get_conversation_id_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1005
+ end
1006
+ return data, status_code, headers
1007
+ end
1008
+ end
1009
+ end
1010
+
1011
+
1012
+
1013
+