purecloud 0.30.1 → 0.31.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. checksums.yaml +4 -4
  2. data/config-ruby.json +1 -1
  3. data/lib/purecloud/api/configuration_api.rb +4 -814
  4. data/lib/purecloud/api/conversations_api.rb +1035 -1763
  5. data/lib/purecloud/api/organization_api.rb +0 -58
  6. data/lib/purecloud/api/quality_api.rb +629 -0
  7. data/lib/purecloud/api/telephony_providers_edge_api.rb +1033 -677
  8. data/lib/purecloud/api/users_api.rb +311 -0
  9. data/lib/purecloud/api/voicemail_api.rb +176 -176
  10. data/lib/purecloud/models/address_listing.rb +17 -17
  11. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  12. data/lib/purecloud/models/aggregate_metric_data.rb +1 -1
  13. data/lib/purecloud/models/analytics_conversation_segment.rb +18 -235
  14. data/lib/purecloud/models/analytics_participant.rb +40 -1
  15. data/lib/purecloud/models/analytics_query_predicate.rb +2 -2
  16. data/lib/purecloud/models/analytics_session.rb +150 -1
  17. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  18. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +17 -17
  19. data/lib/purecloud/models/available_additional_service_listing.rb +17 -17
  20. data/lib/purecloud/models/available_topic_entity_listing.rb +17 -17
  21. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  22. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  23. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  24. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  25. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  26. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  27. data/lib/purecloud/models/carrier_entity_listing.rb +17 -17
  28. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  29. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  30. data/lib/purecloud/models/channel_topic_entity_listing.rb +17 -17
  31. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  32. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  33. data/lib/purecloud/models/consumed_resources_entity_listing.rb +17 -17
  34. data/lib/purecloud/models/consuming_resources_entity_listing.rb +17 -17
  35. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  36. data/lib/purecloud/models/contact_listing.rb +17 -17
  37. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  38. data/lib/purecloud/models/create_user.rb +1 -11
  39. data/lib/purecloud/models/data_item.rb +23 -19
  40. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +17 -17
  41. data/lib/purecloud/models/dependency_object_entity_listing.rb +17 -17
  42. data/lib/purecloud/models/dependency_type_entity_listing.rb +17 -17
  43. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  44. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  45. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  46. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  47. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  48. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +17 -17
  49. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  50. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  51. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  52. data/lib/purecloud/models/domain_invoice_entity_listing.rb +17 -17
  53. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +17 -17
  54. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +17 -17
  55. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +17 -17
  56. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +17 -17
  57. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +17 -17
  58. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  59. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  60. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  61. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  62. data/lib/purecloud/models/email_message_listing.rb +17 -17
  63. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  64. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  65. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  66. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  67. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  68. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  69. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  70. data/lib/purecloud/models/external_organization_listing.rb +17 -17
  71. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  72. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +17 -17
  73. data/lib/purecloud/models/flow_entity_listing.rb +17 -17
  74. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +17 -17
  75. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +17 -17
  76. data/lib/purecloud/models/flow_version_entity_listing.rb +17 -17
  77. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  78. data/lib/purecloud/models/hardware_rate_listing.rb +17 -17
  79. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  80. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  81. data/lib/purecloud/models/integration_type_entity_listing.rb +17 -17
  82. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  83. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  84. data/lib/purecloud/models/ivr_entity_listing.rb +17 -17
  85. data/lib/purecloud/models/json_node.rb +32 -32
  86. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  87. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  88. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  89. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  90. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +17 -17
  91. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +17 -17
  92. data/lib/purecloud/models/location_entity_listing.rb +17 -17
  93. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  94. data/lib/purecloud/models/note_listing.rb +17 -17
  95. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  96. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  97. data/lib/purecloud/models/organization.rb +1 -0
  98. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  99. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  100. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  101. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  102. data/lib/purecloud/models/payment_method_listing.rb +17 -17
  103. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  104. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  105. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  106. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  107. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  108. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  109. data/lib/purecloud/models/prompt_asset_entity_listing.rb +17 -17
  110. data/lib/purecloud/models/prompt_entity_listing.rb +17 -17
  111. data/lib/purecloud/models/property_index_request.rb +1 -12
  112. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  113. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  114. data/lib/purecloud/models/queues_entity_listing.rb +17 -17
  115. data/lib/purecloud/models/quote_listing.rb +17 -17
  116. data/lib/purecloud/models/relationship_listing.rb +17 -17
  117. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  118. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  119. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  120. data/lib/purecloud/models/response_entity_list.rb +17 -17
  121. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  122. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  123. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  124. data/lib/purecloud/models/schedule_entity_listing.rb +17 -17
  125. data/lib/purecloud/models/schedule_group_entity_listing.rb +17 -17
  126. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  127. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  128. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  129. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  130. data/lib/purecloud/models/service_entity_listing.rb +17 -17
  131. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  132. data/lib/purecloud/models/site.rb +1 -1
  133. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  134. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  135. data/lib/purecloud/models/social_conversation_entity_listing.rb +17 -17
  136. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +17 -17
  137. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  138. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +17 -17
  139. data/lib/purecloud/models/system_prompt_entity_listing.rb +17 -17
  140. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  141. data/lib/purecloud/models/template_entity_listing.rb +17 -17
  142. data/lib/purecloud/models/text_table_transform_entity_listing.rb +17 -17
  143. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  144. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  145. data/lib/purecloud/models/user_action_category_entity_listing.rb +17 -17
  146. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  148. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  149. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  150. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  151. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  152. data/lib/purecloud/models/video_conversation_entity_listing.rb +17 -17
  153. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +17 -17
  154. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +17 -17
  155. data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
  156. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  157. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  158. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  159. data/lib/purecloud/version.rb +1 -1
  160. data/lib/purecloud.rb +83 -100
  161. data/newVersion.md +1 -1
  162. data/swagger.json +1 -1
  163. data/version.json +1 -1
  164. metadata +2 -19
  165. data/lib/purecloud/api/callbacks_api.rb +0 -483
  166. data/lib/purecloud/api/calls_api.rb +0 -1088
  167. data/lib/purecloud/api/chats_api.rb +0 -483
  168. data/lib/purecloud/api/compliance_api.rb +0 -129
  169. data/lib/purecloud/api/downloads_api.rb +0 -140
  170. data/lib/purecloud/api/emails_api.rb +0 -1013
  171. data/lib/purecloud/api/evaluations_api.rb +0 -73
  172. data/lib/purecloud/api/faxes_api.rb +0 -73
  173. data/lib/purecloud/api/integrations_api.rb +0 -150
  174. data/lib/purecloud/api/integrations_workforce_management_api.rb +0 -73
  175. data/lib/purecloud/api/licensing_api.rb +0 -428
  176. data/lib/purecloud/api/scripts_api.rb +0 -718
  177. data/lib/purecloud/api/socials_api.rb +0 -483
  178. data/lib/purecloud/api/videos_api.rb +0 -483
  179. data/lib/purecloud/models/body.rb +0 -136
  180. data/lib/purecloud/models/organization_address.rb +0 -194
  181. data/lib/purecloud/models/participant_request.rb +0 -242
@@ -8,31 +8,26 @@ module PureCloud
8
8
  @api_client = api_client
9
9
  end
10
10
 
11
- # Get a user's voicemail policy
11
+ # Get mailbox information
12
12
  #
13
- # @param user_id User ID
14
13
  # @param [Hash] opts the optional parameters
15
- # @return [VoicemailUserPolicy]
16
- def get_uservoicemailpolicies_user_id(user_id, opts = {})
17
- data, status_code, headers = get_uservoicemailpolicies_user_id_with_http_info(user_id, opts)
14
+ # @return [VoicemailMailboxInfo]
15
+ def get_mailbox(opts = {})
16
+ data, status_code, headers = get_mailbox_with_http_info(opts)
18
17
  return data
19
18
  end
20
19
 
21
- # Get a user's voicemail policy
20
+ # Get mailbox information
22
21
  #
23
- # @param user_id User ID
24
22
  # @param [Hash] opts the optional parameters
25
- # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
26
- def get_uservoicemailpolicies_user_id_with_http_info(user_id, opts = {})
23
+ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
24
+ def get_mailbox_with_http_info(opts = {})
27
25
  if @api_client.config.debugging
28
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_uservoicemailpolicies_user_id ..."
26
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..."
29
27
  end
30
28
 
31
- # verify the required parameter 'user_id' is set
32
- fail "Missing the required parameter 'user_id' when calling get_uservoicemailpolicies_user_id" if user_id.nil?
33
-
34
29
  # resource path
35
- path = "/api/v2/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
30
+ path = "/api/v2/voicemail/mailbox".sub('{format}','json')
36
31
 
37
32
  # query parameters
38
33
  query_params = {}
@@ -62,43 +57,33 @@ module PureCloud
62
57
  :form_params => form_params,
63
58
  :body => post_body,
64
59
  :auth_names => auth_names,
65
- :return_type => 'VoicemailUserPolicy')
60
+ :return_type => 'VoicemailMailboxInfo')
66
61
  if @api_client.config.debugging
67
- @api_client.config.logger.debug "API called: VoicemailApi#get_uservoicemailpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
62
+ @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
68
63
  end
69
64
  return data, status_code, headers
70
65
  end
71
66
 
72
- # Update a user&#39;s voicemail policy
67
+ # List voicemail messages
73
68
  #
74
- # @param user_id User ID
75
- # @param body The user&#39;s voicemail policy
76
69
  # @param [Hash] opts the optional parameters
77
- # @return [VoicemailUserPolicy]
78
- def patch_uservoicemailpolicies_user_id(user_id, body, opts = {})
79
- data, status_code, headers = patch_uservoicemailpolicies_user_id_with_http_info(user_id, body, opts)
70
+ # @return [VoicemailMessageEntityListing]
71
+ def get_messages(opts = {})
72
+ data, status_code, headers = get_messages_with_http_info(opts)
80
73
  return data
81
74
  end
82
75
 
83
- # Update a user&#39;s voicemail policy
76
+ # List voicemail messages
84
77
  #
85
- # @param user_id User ID
86
- # @param body The user&#39;s voicemail policy
87
78
  # @param [Hash] opts the optional parameters
88
- # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
89
- def patch_uservoicemailpolicies_user_id_with_http_info(user_id, body, opts = {})
79
+ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers
80
+ def get_messages_with_http_info(opts = {})
90
81
  if @api_client.config.debugging
91
- @api_client.config.logger.debug "Calling API: VoicemailApi#patch_uservoicemailpolicies_user_id ..."
82
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages ..."
92
83
  end
93
84
 
94
- # verify the required parameter 'user_id' is set
95
- fail "Missing the required parameter 'user_id' when calling patch_uservoicemailpolicies_user_id" if user_id.nil?
96
-
97
- # verify the required parameter 'body' is set
98
- fail "Missing the required parameter 'body' when calling patch_uservoicemailpolicies_user_id" if body.nil?
99
-
100
85
  # resource path
101
- path = "/api/v2/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
86
+ path = "/api/v2/voicemail/messages".sub('{format}','json')
102
87
 
103
88
  # query parameters
104
89
  query_params = {}
@@ -118,43 +103,43 @@ module PureCloud
118
103
  form_params = {}
119
104
 
120
105
  # http body (model)
121
- post_body = @api_client.object_to_http_body(body)
106
+ post_body = nil
122
107
 
123
108
 
124
109
  auth_names = ['PureCloud Auth']
125
- data, status_code, headers = @api_client.call_api(:PATCH, path,
110
+ data, status_code, headers = @api_client.call_api(:GET, path,
126
111
  :header_params => header_params,
127
112
  :query_params => query_params,
128
113
  :form_params => form_params,
129
114
  :body => post_body,
130
115
  :auth_names => auth_names,
131
- :return_type => 'VoicemailUserPolicy')
116
+ :return_type => 'VoicemailMessageEntityListing')
132
117
  if @api_client.config.debugging
133
- @api_client.config.logger.debug "API called: VoicemailApi#patch_uservoicemailpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
118
+ @api_client.config.logger.debug "API called: VoicemailApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
134
119
  end
135
120
  return data, status_code, headers
136
121
  end
137
122
 
138
- # Get a policy
123
+ # Delete all voicemail messages
139
124
  #
140
125
  # @param [Hash] opts the optional parameters
141
- # @return [VoicemailOrganizationPolicy]
142
- def get_voicemailpolicy(opts = {})
143
- data, status_code, headers = get_voicemailpolicy_with_http_info(opts)
126
+ # @return [String]
127
+ def delete_messages(opts = {})
128
+ data, status_code, headers = delete_messages_with_http_info(opts)
144
129
  return data
145
130
  end
146
131
 
147
- # Get a policy
132
+ # Delete all voicemail messages
148
133
  #
149
134
  # @param [Hash] opts the optional parameters
150
- # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers
151
- def get_voicemailpolicy_with_http_info(opts = {})
135
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
136
+ def delete_messages_with_http_info(opts = {})
152
137
  if @api_client.config.debugging
153
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_voicemailpolicy ..."
138
+ @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages ..."
154
139
  end
155
140
 
156
141
  # resource path
157
- path = "/api/v2/configuration/voicemailpolicy".sub('{format}','json')
142
+ path = "/api/v2/voicemail/messages".sub('{format}','json')
158
143
 
159
144
  # query parameters
160
145
  query_params = {}
@@ -178,41 +163,44 @@ module PureCloud
178
163
 
179
164
 
180
165
  auth_names = ['PureCloud Auth']
181
- data, status_code, headers = @api_client.call_api(:GET, path,
166
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
182
167
  :header_params => header_params,
183
168
  :query_params => query_params,
184
169
  :form_params => form_params,
185
170
  :body => post_body,
186
171
  :auth_names => auth_names,
187
- :return_type => 'VoicemailOrganizationPolicy')
172
+ :return_type => 'String')
188
173
  if @api_client.config.debugging
189
- @api_client.config.logger.debug "API called: VoicemailApi#get_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
174
+ @api_client.config.logger.debug "API called: VoicemailApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
190
175
  end
191
176
  return data, status_code, headers
192
177
  end
193
178
 
194
- # Update a policy
179
+ # Get message.
195
180
  #
181
+ # @param message_id Message ID
196
182
  # @param [Hash] opts the optional parameters
197
- # @option opts [VoicemailOrganizationPolicy] :body Policy
198
- # @return [VoicemailOrganizationPolicy]
199
- def put_voicemailpolicy(opts = {})
200
- data, status_code, headers = put_voicemailpolicy_with_http_info(opts)
183
+ # @return [VoicemailMessage]
184
+ def get_messages_message_id(message_id, opts = {})
185
+ data, status_code, headers = get_messages_message_id_with_http_info(message_id, opts)
201
186
  return data
202
187
  end
203
188
 
204
- # Update a policy
189
+ # Get message.
205
190
  #
191
+ # @param message_id Message ID
206
192
  # @param [Hash] opts the optional parameters
207
- # @option opts [VoicemailOrganizationPolicy] :body Policy
208
- # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers
209
- def put_voicemailpolicy_with_http_info(opts = {})
193
+ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
194
+ def get_messages_message_id_with_http_info(message_id, opts = {})
210
195
  if @api_client.config.debugging
211
- @api_client.config.logger.debug "Calling API: VoicemailApi#put_voicemailpolicy ..."
196
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id ..."
212
197
  end
213
198
 
199
+ # verify the required parameter 'message_id' is set
200
+ fail "Missing the required parameter 'message_id' when calling get_messages_message_id" if message_id.nil?
201
+
214
202
  # resource path
215
- path = "/api/v2/configuration/voicemailpolicy".sub('{format}','json')
203
+ path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
216
204
 
217
205
  # query parameters
218
206
  query_params = {}
@@ -232,43 +220,50 @@ module PureCloud
232
220
  form_params = {}
233
221
 
234
222
  # http body (model)
235
- post_body = @api_client.object_to_http_body(opts[:'body'])
223
+ post_body = nil
236
224
 
237
225
 
238
226
  auth_names = ['PureCloud Auth']
239
- data, status_code, headers = @api_client.call_api(:PUT, path,
227
+ data, status_code, headers = @api_client.call_api(:GET, path,
240
228
  :header_params => header_params,
241
229
  :query_params => query_params,
242
230
  :form_params => form_params,
243
231
  :body => post_body,
244
232
  :auth_names => auth_names,
245
- :return_type => 'VoicemailOrganizationPolicy')
233
+ :return_type => 'VoicemailMessage')
246
234
  if @api_client.config.debugging
247
- @api_client.config.logger.debug "API called: VoicemailApi#put_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
236
  end
249
237
  return data, status_code, headers
250
238
  end
251
239
 
252
- # Get mailbox information
240
+ # Update a message.
253
241
  #
242
+ # @param message_id Message ID
254
243
  # @param [Hash] opts the optional parameters
255
- # @return [VoicemailMailboxInfo]
256
- def get_mailbox(opts = {})
257
- data, status_code, headers = get_mailbox_with_http_info(opts)
244
+ # @option opts [VoicemailMessage] :body VoicemailMessage
245
+ # @return [VoicemailMessage]
246
+ def put_messages_message_id(message_id, opts = {})
247
+ data, status_code, headers = put_messages_message_id_with_http_info(message_id, opts)
258
248
  return data
259
249
  end
260
250
 
261
- # Get mailbox information
251
+ # Update a message.
262
252
  #
253
+ # @param message_id Message ID
263
254
  # @param [Hash] opts the optional parameters
264
- # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers
265
- def get_mailbox_with_http_info(opts = {})
255
+ # @option opts [VoicemailMessage] :body VoicemailMessage
256
+ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
257
+ def put_messages_message_id_with_http_info(message_id, opts = {})
266
258
  if @api_client.config.debugging
267
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..."
259
+ @api_client.config.logger.debug "Calling API: VoicemailApi#put_messages_message_id ..."
268
260
  end
269
261
 
262
+ # verify the required parameter 'message_id' is set
263
+ fail "Missing the required parameter 'message_id' when calling put_messages_message_id" if message_id.nil?
264
+
270
265
  # resource path
271
- path = "/api/v2/voicemail/mailbox".sub('{format}','json')
266
+ path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
272
267
 
273
268
  # query parameters
274
269
  query_params = {}
@@ -288,43 +283,48 @@ module PureCloud
288
283
  form_params = {}
289
284
 
290
285
  # http body (model)
291
- post_body = nil
286
+ post_body = @api_client.object_to_http_body(opts[:'body'])
292
287
 
293
288
 
294
289
  auth_names = ['PureCloud Auth']
295
- data, status_code, headers = @api_client.call_api(:GET, path,
290
+ data, status_code, headers = @api_client.call_api(:PUT, path,
296
291
  :header_params => header_params,
297
292
  :query_params => query_params,
298
293
  :form_params => form_params,
299
294
  :body => post_body,
300
295
  :auth_names => auth_names,
301
- :return_type => 'VoicemailMailboxInfo')
296
+ :return_type => 'VoicemailMessage')
302
297
  if @api_client.config.debugging
303
- @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
+ @api_client.config.logger.debug "API called: VoicemailApi#put_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
304
299
  end
305
300
  return data, status_code, headers
306
301
  end
307
302
 
308
- # List voicemail messages
303
+ # Delete a message.
309
304
  #
305
+ # @param message_id Message ID
310
306
  # @param [Hash] opts the optional parameters
311
- # @return [VoicemailMessageEntityListing]
312
- def get_messages(opts = {})
313
- data, status_code, headers = get_messages_with_http_info(opts)
307
+ # @return [String]
308
+ def delete_messages_message_id(message_id, opts = {})
309
+ data, status_code, headers = delete_messages_message_id_with_http_info(message_id, opts)
314
310
  return data
315
311
  end
316
312
 
317
- # List voicemail messages
313
+ # Delete a message.
318
314
  #
315
+ # @param message_id Message ID
319
316
  # @param [Hash] opts the optional parameters
320
- # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers
321
- def get_messages_with_http_info(opts = {})
317
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
318
+ def delete_messages_message_id_with_http_info(message_id, opts = {})
322
319
  if @api_client.config.debugging
323
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages ..."
320
+ @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages_message_id ..."
324
321
  end
325
322
 
323
+ # verify the required parameter 'message_id' is set
324
+ fail "Missing the required parameter 'message_id' when calling delete_messages_message_id" if message_id.nil?
325
+
326
326
  # resource path
327
- path = "/api/v2/voicemail/messages".sub('{format}','json')
327
+ path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
328
328
 
329
329
  # query parameters
330
330
  query_params = {}
@@ -348,42 +348,54 @@ module PureCloud
348
348
 
349
349
 
350
350
  auth_names = ['PureCloud Auth']
351
- data, status_code, headers = @api_client.call_api(:GET, path,
351
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
352
352
  :header_params => header_params,
353
353
  :query_params => query_params,
354
354
  :form_params => form_params,
355
355
  :body => post_body,
356
356
  :auth_names => auth_names,
357
- :return_type => 'VoicemailMessageEntityListing')
357
+ :return_type => 'String')
358
358
  if @api_client.config.debugging
359
- @api_client.config.logger.debug "API called: VoicemailApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
359
+ @api_client.config.logger.debug "API called: VoicemailApi#delete_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
360
360
  end
361
361
  return data, status_code, headers
362
362
  end
363
363
 
364
- # Delete all voicemail messages
364
+ # Get media playback URI for this message
365
365
  #
366
+ # @param message_id Message ID
366
367
  # @param [Hash] opts the optional parameters
367
- # @return [String]
368
- def delete_messages(opts = {})
369
- data, status_code, headers = delete_messages_with_http_info(opts)
368
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
369
+ # @return [VoicemailMediaInfo]
370
+ def get_messages_message_id_media(message_id, opts = {})
371
+ data, status_code, headers = get_messages_message_id_media_with_http_info(message_id, opts)
370
372
  return data
371
373
  end
372
374
 
373
- # Delete all voicemail messages
375
+ # Get media playback URI for this message
374
376
  #
377
+ # @param message_id Message ID
375
378
  # @param [Hash] opts the optional parameters
376
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
377
- def delete_messages_with_http_info(opts = {})
379
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
380
+ # @return [Array<(VoicemailMediaInfo, Fixnum, Hash)>] VoicemailMediaInfo data, response status code and response headers
381
+ def get_messages_message_id_media_with_http_info(message_id, opts = {})
378
382
  if @api_client.config.debugging
379
- @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages ..."
383
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id_media ..."
384
+ end
385
+
386
+ # verify the required parameter 'message_id' is set
387
+ fail "Missing the required parameter 'message_id' when calling get_messages_message_id_media" if message_id.nil?
388
+
389
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
390
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
380
391
  end
381
392
 
382
393
  # resource path
383
- path = "/api/v2/voicemail/messages".sub('{format}','json')
394
+ path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
384
395
 
385
396
  # query parameters
386
397
  query_params = {}
398
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
387
399
 
388
400
  # header parameters
389
401
  header_params = {}
@@ -404,44 +416,39 @@ module PureCloud
404
416
 
405
417
 
406
418
  auth_names = ['PureCloud Auth']
407
- data, status_code, headers = @api_client.call_api(:DELETE, path,
419
+ data, status_code, headers = @api_client.call_api(:GET, path,
408
420
  :header_params => header_params,
409
421
  :query_params => query_params,
410
422
  :form_params => form_params,
411
423
  :body => post_body,
412
424
  :auth_names => auth_names,
413
- :return_type => 'String')
425
+ :return_type => 'VoicemailMediaInfo')
414
426
  if @api_client.config.debugging
415
- @api_client.config.logger.debug "API called: VoicemailApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
427
+ @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
416
428
  end
417
429
  return data, status_code, headers
418
430
  end
419
431
 
420
- # Get message.
432
+ # Get a policy
421
433
  #
422
- # @param message_id Message ID
423
434
  # @param [Hash] opts the optional parameters
424
- # @return [VoicemailMessage]
425
- def get_messages_message_id(message_id, opts = {})
426
- data, status_code, headers = get_messages_message_id_with_http_info(message_id, opts)
435
+ # @return [VoicemailOrganizationPolicy]
436
+ def get_policy(opts = {})
437
+ data, status_code, headers = get_policy_with_http_info(opts)
427
438
  return data
428
439
  end
429
440
 
430
- # Get message.
441
+ # Get a policy
431
442
  #
432
- # @param message_id Message ID
433
443
  # @param [Hash] opts the optional parameters
434
- # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
435
- def get_messages_message_id_with_http_info(message_id, opts = {})
444
+ # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers
445
+ def get_policy_with_http_info(opts = {})
436
446
  if @api_client.config.debugging
437
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id ..."
447
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_policy ..."
438
448
  end
439
449
 
440
- # verify the required parameter 'message_id' is set
441
- fail "Missing the required parameter 'message_id' when calling get_messages_message_id" if message_id.nil?
442
-
443
450
  # resource path
444
- path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
451
+ path = "/api/v2/voicemail/policy".sub('{format}','json')
445
452
 
446
453
  # query parameters
447
454
  query_params = {}
@@ -471,40 +478,35 @@ module PureCloud
471
478
  :form_params => form_params,
472
479
  :body => post_body,
473
480
  :auth_names => auth_names,
474
- :return_type => 'VoicemailMessage')
481
+ :return_type => 'VoicemailOrganizationPolicy')
475
482
  if @api_client.config.debugging
476
- @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
483
+ @api_client.config.logger.debug "API called: VoicemailApi#get_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
477
484
  end
478
485
  return data, status_code, headers
479
486
  end
480
487
 
481
- # Update a message.
488
+ # Update a policy
482
489
  #
483
- # @param message_id Message ID
484
490
  # @param [Hash] opts the optional parameters
485
- # @option opts [VoicemailMessage] :body VoicemailMessage
486
- # @return [VoicemailMessage]
487
- def put_messages_message_id(message_id, opts = {})
488
- data, status_code, headers = put_messages_message_id_with_http_info(message_id, opts)
491
+ # @option opts [VoicemailOrganizationPolicy] :body Policy
492
+ # @return [VoicemailOrganizationPolicy]
493
+ def put_policy(opts = {})
494
+ data, status_code, headers = put_policy_with_http_info(opts)
489
495
  return data
490
496
  end
491
497
 
492
- # Update a message.
498
+ # Update a policy
493
499
  #
494
- # @param message_id Message ID
495
500
  # @param [Hash] opts the optional parameters
496
- # @option opts [VoicemailMessage] :body VoicemailMessage
497
- # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
498
- def put_messages_message_id_with_http_info(message_id, opts = {})
501
+ # @option opts [VoicemailOrganizationPolicy] :body Policy
502
+ # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers
503
+ def put_policy_with_http_info(opts = {})
499
504
  if @api_client.config.debugging
500
- @api_client.config.logger.debug "Calling API: VoicemailApi#put_messages_message_id ..."
505
+ @api_client.config.logger.debug "Calling API: VoicemailApi#put_policy ..."
501
506
  end
502
507
 
503
- # verify the required parameter 'message_id' is set
504
- fail "Missing the required parameter 'message_id' when calling put_messages_message_id" if message_id.nil?
505
-
506
508
  # resource path
507
- path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
509
+ path = "/api/v2/voicemail/policy".sub('{format}','json')
508
510
 
509
511
  # query parameters
510
512
  query_params = {}
@@ -534,38 +536,38 @@ module PureCloud
534
536
  :form_params => form_params,
535
537
  :body => post_body,
536
538
  :auth_names => auth_names,
537
- :return_type => 'VoicemailMessage')
539
+ :return_type => 'VoicemailOrganizationPolicy')
538
540
  if @api_client.config.debugging
539
- @api_client.config.logger.debug "API called: VoicemailApi#put_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
541
+ @api_client.config.logger.debug "API called: VoicemailApi#put_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
540
542
  end
541
543
  return data, status_code, headers
542
544
  end
543
545
 
544
- # Delete a message.
546
+ # Get a user&#39;s voicemail policy
545
547
  #
546
- # @param message_id Message ID
548
+ # @param user_id User ID
547
549
  # @param [Hash] opts the optional parameters
548
- # @return [String]
549
- def delete_messages_message_id(message_id, opts = {})
550
- data, status_code, headers = delete_messages_message_id_with_http_info(message_id, opts)
550
+ # @return [VoicemailUserPolicy]
551
+ def get_userpolicies_user_id(user_id, opts = {})
552
+ data, status_code, headers = get_userpolicies_user_id_with_http_info(user_id, opts)
551
553
  return data
552
554
  end
553
555
 
554
- # Delete a message.
556
+ # Get a user&#39;s voicemail policy
555
557
  #
556
- # @param message_id Message ID
558
+ # @param user_id User ID
557
559
  # @param [Hash] opts the optional parameters
558
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
559
- def delete_messages_message_id_with_http_info(message_id, opts = {})
560
+ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
561
+ def get_userpolicies_user_id_with_http_info(user_id, opts = {})
560
562
  if @api_client.config.debugging
561
- @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages_message_id ..."
563
+ @api_client.config.logger.debug "Calling API: VoicemailApi#get_userpolicies_user_id ..."
562
564
  end
563
565
 
564
- # verify the required parameter 'message_id' is set
565
- fail "Missing the required parameter 'message_id' when calling delete_messages_message_id" if message_id.nil?
566
+ # verify the required parameter 'user_id' is set
567
+ fail "Missing the required parameter 'user_id' when calling get_userpolicies_user_id" if user_id.nil?
566
568
 
567
569
  # resource path
568
- path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
570
+ path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
569
571
 
570
572
  # query parameters
571
573
  query_params = {}
@@ -589,54 +591,52 @@ module PureCloud
589
591
 
590
592
 
591
593
  auth_names = ['PureCloud Auth']
592
- data, status_code, headers = @api_client.call_api(:DELETE, path,
594
+ data, status_code, headers = @api_client.call_api(:GET, path,
593
595
  :header_params => header_params,
594
596
  :query_params => query_params,
595
597
  :form_params => form_params,
596
598
  :body => post_body,
597
599
  :auth_names => auth_names,
598
- :return_type => 'String')
600
+ :return_type => 'VoicemailUserPolicy')
599
601
  if @api_client.config.debugging
600
- @api_client.config.logger.debug "API called: VoicemailApi#delete_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
602
+ @api_client.config.logger.debug "API called: VoicemailApi#get_userpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
601
603
  end
602
604
  return data, status_code, headers
603
605
  end
604
606
 
605
- # Get media playback URI for this message
607
+ # Update a user&#39;s voicemail policy
606
608
  #
607
- # @param message_id Message ID
609
+ # @param user_id User ID
610
+ # @param body The user&#39;s voicemail policy
608
611
  # @param [Hash] opts the optional parameters
609
- # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
610
- # @return [VoicemailMediaInfo]
611
- def get_messages_message_id_media(message_id, opts = {})
612
- data, status_code, headers = get_messages_message_id_media_with_http_info(message_id, opts)
612
+ # @return [VoicemailUserPolicy]
613
+ def patch_userpolicies_user_id(user_id, body, opts = {})
614
+ data, status_code, headers = patch_userpolicies_user_id_with_http_info(user_id, body, opts)
613
615
  return data
614
616
  end
615
617
 
616
- # Get media playback URI for this message
618
+ # Update a user&#39;s voicemail policy
617
619
  #
618
- # @param message_id Message ID
620
+ # @param user_id User ID
621
+ # @param body The user&#39;s voicemail policy
619
622
  # @param [Hash] opts the optional parameters
620
- # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
621
- # @return [Array<(VoicemailMediaInfo, Fixnum, Hash)>] VoicemailMediaInfo data, response status code and response headers
622
- def get_messages_message_id_media_with_http_info(message_id, opts = {})
623
+ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers
624
+ def patch_userpolicies_user_id_with_http_info(user_id, body, opts = {})
623
625
  if @api_client.config.debugging
624
- @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id_media ..."
626
+ @api_client.config.logger.debug "Calling API: VoicemailApi#patch_userpolicies_user_id ..."
625
627
  end
626
628
 
627
- # verify the required parameter 'message_id' is set
628
- fail "Missing the required parameter 'message_id' when calling get_messages_message_id_media" if message_id.nil?
629
+ # verify the required parameter 'user_id' is set
630
+ fail "Missing the required parameter 'user_id' when calling patch_userpolicies_user_id" if user_id.nil?
629
631
 
630
- if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
631
- fail 'invalid value for "format_id", must be one of WEBM, WAV'
632
- end
632
+ # verify the required parameter 'body' is set
633
+ fail "Missing the required parameter 'body' when calling patch_userpolicies_user_id" if body.nil?
633
634
 
634
635
  # resource path
635
- path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)
636
+ path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
636
637
 
637
638
  # query parameters
638
639
  query_params = {}
639
- query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
640
640
 
641
641
  # header parameters
642
642
  header_params = {}
@@ -653,19 +653,19 @@ module PureCloud
653
653
  form_params = {}
654
654
 
655
655
  # http body (model)
656
- post_body = nil
656
+ post_body = @api_client.object_to_http_body(body)
657
657
 
658
658
 
659
659
  auth_names = ['PureCloud Auth']
660
- data, status_code, headers = @api_client.call_api(:GET, path,
660
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
661
661
  :header_params => header_params,
662
662
  :query_params => query_params,
663
663
  :form_params => form_params,
664
664
  :body => post_body,
665
665
  :auth_names => auth_names,
666
- :return_type => 'VoicemailMediaInfo')
666
+ :return_type => 'VoicemailUserPolicy')
667
667
  if @api_client.config.debugging
668
- @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
668
+ @api_client.config.logger.debug "API called: VoicemailApi#patch_userpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
669
669
  end
670
670
  return data, status_code, headers
671
671
  end