lib/purecloud/api/voicemail_api.rb in purecloud-0.30.1 vs lib/purecloud/api/voicemail_api.rb in purecloud-0.31.1

- old
+ new

@@ -6,35 +6,30 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end - # Get a user&#39;s voicemail policy + # Get mailbox information # - # @param user_id User ID # @param [Hash] opts the optional parameters - # @return [VoicemailUserPolicy] - def get_uservoicemailpolicies_user_id(user_id, opts = {}) - data, status_code, headers = get_uservoicemailpolicies_user_id_with_http_info(user_id, opts) + # @return [VoicemailMailboxInfo] + def get_mailbox(opts = {}) + data, status_code, headers = get_mailbox_with_http_info(opts) return data end - # Get a user&#39;s voicemail policy + # Get mailbox information # - # @param user_id User ID # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers - def get_uservoicemailpolicies_user_id_with_http_info(user_id, opts = {}) + # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers + def get_mailbox_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_uservoicemailpolicies_user_id ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..." end - # verify the required parameter 'user_id' is set - fail "Missing the required parameter 'user_id' when calling get_uservoicemailpolicies_user_id" if user_id.nil? - # resource path - path = "/api/v2/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) + path = "/api/v2/voicemail/mailbox".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -60,47 +55,37 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailUserPolicy') + :return_type => 'VoicemailMailboxInfo') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_uservoicemailpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update a user&#39;s voicemail policy + # List voicemail messages # - # @param user_id User ID - # @param body The user&#39;s voicemail policy # @param [Hash] opts the optional parameters - # @return [VoicemailUserPolicy] - def patch_uservoicemailpolicies_user_id(user_id, body, opts = {}) - data, status_code, headers = patch_uservoicemailpolicies_user_id_with_http_info(user_id, body, opts) + # @return [VoicemailMessageEntityListing] + def get_messages(opts = {}) + data, status_code, headers = get_messages_with_http_info(opts) return data end - # Update a user&#39;s voicemail policy + # List voicemail messages # - # @param user_id User ID - # @param body The user&#39;s voicemail policy # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers - def patch_uservoicemailpolicies_user_id_with_http_info(user_id, body, opts = {}) + # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers + def get_messages_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#patch_uservoicemailpolicies_user_id ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages ..." end - # verify the required parameter 'user_id' is set - fail "Missing the required parameter 'user_id' when calling patch_uservoicemailpolicies_user_id" if user_id.nil? - - # verify the required parameter 'body' is set - fail "Missing the required parameter 'body' when calling patch_uservoicemailpolicies_user_id" if body.nil? - # resource path - path = "/api/v2/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) + path = "/api/v2/voicemail/messages".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -116,47 +101,47 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(body) + post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PATCH, path, + data, status_code, headers = @api_client.call_api(:GET, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailUserPolicy') + :return_type => 'VoicemailMessageEntityListing') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#patch_uservoicemailpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get a policy + # Delete all voicemail messages # # @param [Hash] opts the optional parameters - # @return [VoicemailOrganizationPolicy] - def get_voicemailpolicy(opts = {}) - data, status_code, headers = get_voicemailpolicy_with_http_info(opts) + # @return [String] + def delete_messages(opts = {}) + data, status_code, headers = delete_messages_with_http_info(opts) return data end - # Get a policy + # Delete all voicemail messages # # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers - def get_voicemailpolicy_with_http_info(opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_messages_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_voicemailpolicy ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages ..." end # resource path - path = "/api/v2/configuration/voicemailpolicy".sub('{format}','json') + path = "/api/v2/voicemail/messages".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -176,45 +161,48 @@ # http body (model) post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:DELETE, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailOrganizationPolicy') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update a policy + # Get message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @option opts [VoicemailOrganizationPolicy] :body Policy - # @return [VoicemailOrganizationPolicy] - def put_voicemailpolicy(opts = {}) - data, status_code, headers = put_voicemailpolicy_with_http_info(opts) + # @return [VoicemailMessage] + def get_messages_message_id(message_id, opts = {}) + data, status_code, headers = get_messages_message_id_with_http_info(message_id, opts) return data end - # Update a policy + # Get message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @option opts [VoicemailOrganizationPolicy] :body Policy - # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers - def put_voicemailpolicy_with_http_info(opts = {}) + # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers + def get_messages_message_id_with_http_info(message_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#put_voicemailpolicy ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id ..." end + # verify the required parameter 'message_id' is set + fail "Missing the required parameter 'message_id' when calling get_messages_message_id" if message_id.nil? + # resource path - path = "/api/v2/configuration/voicemailpolicy".sub('{format}','json') + path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters @@ -230,47 +218,54 @@ # form parameters form_params = {} # http body (model) - post_body = @api_client.object_to_http_body(opts[:'body']) + post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:PUT, path, + data, status_code, headers = @api_client.call_api(:GET, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailOrganizationPolicy') + :return_type => 'VoicemailMessage') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#put_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get mailbox information + # Update a message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [VoicemailMailboxInfo] - def get_mailbox(opts = {}) - data, status_code, headers = get_mailbox_with_http_info(opts) + # @option opts [VoicemailMessage] :body VoicemailMessage + # @return [VoicemailMessage] + def put_messages_message_id(message_id, opts = {}) + data, status_code, headers = put_messages_message_id_with_http_info(message_id, opts) return data end - # Get mailbox information + # Update a message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers - def get_mailbox_with_http_info(opts = {}) + # @option opts [VoicemailMessage] :body VoicemailMessage + # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers + def put_messages_message_id_with_http_info(message_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#put_messages_message_id ..." end + # verify the required parameter 'message_id' is set + fail "Missing the required parameter 'message_id' when calling put_messages_message_id" if message_id.nil? + # resource path - path = "/api/v2/voicemail/mailbox".sub('{format}','json') + path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters @@ -286,47 +281,52 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:PUT, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailMailboxInfo') + :return_type => 'VoicemailMessage') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#put_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # List voicemail messages + # Delete a message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [VoicemailMessageEntityListing] - def get_messages(opts = {}) - data, status_code, headers = get_messages_with_http_info(opts) + # @return [String] + def delete_messages_message_id(message_id, opts = {}) + data, status_code, headers = delete_messages_message_id_with_http_info(message_id, opts) return data end - # List voicemail messages + # Delete a message. # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers - def get_messages_with_http_info(opts = {}) + # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers + def delete_messages_message_id_with_http_info(message_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages_message_id ..." end + # verify the required parameter 'message_id' is set + fail "Missing the required parameter 'message_id' when calling delete_messages_message_id" if message_id.nil? + # resource path - path = "/api/v2/voicemail/messages".sub('{format}','json') + path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters @@ -346,46 +346,58 @@ # http body (model) post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:DELETE, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailMessageEntityListing') + :return_type => 'String') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#delete_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete all voicemail messages + # Get media playback URI for this message # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_messages(opts = {}) - data, status_code, headers = delete_messages_with_http_info(opts) + # @option opts [String] :format_id The desired format (WEBM, WAV, etc.) + # @return [VoicemailMediaInfo] + def get_messages_message_id_media(message_id, opts = {}) + data, status_code, headers = get_messages_message_id_media_with_http_info(message_id, opts) return data end - # Delete all voicemail messages + # Get media playback URI for this message # + # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_messages_with_http_info(opts = {}) + # @option opts [String] :format_id The desired format (WEBM, WAV, etc.) + # @return [Array<(VoicemailMediaInfo, Fixnum, Hash)>] VoicemailMediaInfo data, response status code and response headers + def get_messages_message_id_media_with_http_info(message_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id_media ..." end + # verify the required parameter 'message_id' is set + fail "Missing the required parameter 'message_id' when calling get_messages_message_id_media" if message_id.nil? + + if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id']) + fail 'invalid value for "format_id", must be one of WEBM, WAV' + end + # resource path - path = "/api/v2/voicemail/messages".sub('{format}','json') + path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} + query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -402,48 +414,43 @@ # http body (model) post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:GET, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'VoicemailMediaInfo') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get message. + # Get a policy # - # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [VoicemailMessage] - def get_messages_message_id(message_id, opts = {}) - data, status_code, headers = get_messages_message_id_with_http_info(message_id, opts) + # @return [VoicemailOrganizationPolicy] + def get_policy(opts = {}) + data, status_code, headers = get_policy_with_http_info(opts) return data end - # Get message. + # Get a policy # - # @param message_id Message ID # @param [Hash] opts the optional parameters - # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers - def get_messages_message_id_with_http_info(message_id, opts = {}) + # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers + def get_policy_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_policy ..." end - # verify the required parameter 'message_id' is set - fail "Missing the required parameter 'message_id' when calling get_messages_message_id" if message_id.nil? - # resource path - path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) + path = "/api/v2/voicemail/policy".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -469,44 +476,39 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailMessage') + :return_type => 'VoicemailOrganizationPolicy') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Update a message. + # Update a policy # - # @param message_id Message ID # @param [Hash] opts the optional parameters - # @option opts [VoicemailMessage] :body VoicemailMessage - # @return [VoicemailMessage] - def put_messages_message_id(message_id, opts = {}) - data, status_code, headers = put_messages_message_id_with_http_info(message_id, opts) + # @option opts [VoicemailOrganizationPolicy] :body Policy + # @return [VoicemailOrganizationPolicy] + def put_policy(opts = {}) + data, status_code, headers = put_policy_with_http_info(opts) return data end - # Update a message. + # Update a policy # - # @param message_id Message ID # @param [Hash] opts the optional parameters - # @option opts [VoicemailMessage] :body VoicemailMessage - # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers - def put_messages_message_id_with_http_info(message_id, opts = {}) + # @option opts [VoicemailOrganizationPolicy] :body Policy + # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers + def put_policy_with_http_info(opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#put_messages_message_id ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#put_policy ..." end - # verify the required parameter 'message_id' is set - fail "Missing the required parameter 'message_id' when calling put_messages_message_id" if message_id.nil? - # resource path - path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) + path = "/api/v2/voicemail/policy".sub('{format}','json') # query parameters query_params = {} # header parameters @@ -532,42 +534,42 @@ :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailMessage') + :return_type => 'VoicemailOrganizationPolicy') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#put_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#put_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Delete a message. + # Get a user&#39;s voicemail policy # - # @param message_id Message ID + # @param user_id User ID # @param [Hash] opts the optional parameters - # @return [String] - def delete_messages_message_id(message_id, opts = {}) - data, status_code, headers = delete_messages_message_id_with_http_info(message_id, opts) + # @return [VoicemailUserPolicy] + def get_userpolicies_user_id(user_id, opts = {}) + data, status_code, headers = get_userpolicies_user_id_with_http_info(user_id, opts) return data end - # Delete a message. + # Get a user&#39;s voicemail policy # - # @param message_id Message ID + # @param user_id User ID # @param [Hash] opts the optional parameters - # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers - def delete_messages_message_id_with_http_info(message_id, opts = {}) + # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers + def get_userpolicies_user_id_with_http_info(user_id, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages_message_id ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#get_userpolicies_user_id ..." end - # verify the required parameter 'message_id' is set - fail "Missing the required parameter 'message_id' when calling delete_messages_message_id" if message_id.nil? + # verify the required parameter 'user_id' is set + fail "Missing the required parameter 'user_id' when calling get_userpolicies_user_id" if user_id.nil? # resource path - path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) + path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters @@ -587,58 +589,56 @@ # http body (model) post_body = nil auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:DELETE, path, + data, status_code, headers = @api_client.call_api(:GET, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'String') + :return_type => 'VoicemailUserPolicy') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#delete_messages_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#get_userpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end - # Get media playback URI for this message + # Update a user&#39;s voicemail policy # - # @param message_id Message ID + # @param user_id User ID + # @param body The user&#39;s voicemail policy # @param [Hash] opts the optional parameters - # @option opts [String] :format_id The desired format (WEBM, WAV, etc.) - # @return [VoicemailMediaInfo] - def get_messages_message_id_media(message_id, opts = {}) - data, status_code, headers = get_messages_message_id_media_with_http_info(message_id, opts) + # @return [VoicemailUserPolicy] + def patch_userpolicies_user_id(user_id, body, opts = {}) + data, status_code, headers = patch_userpolicies_user_id_with_http_info(user_id, body, opts) return data end - # Get media playback URI for this message + # Update a user&#39;s voicemail policy # - # @param message_id Message ID + # @param user_id User ID + # @param body The user&#39;s voicemail policy # @param [Hash] opts the optional parameters - # @option opts [String] :format_id The desired format (WEBM, WAV, etc.) - # @return [Array<(VoicemailMediaInfo, Fixnum, Hash)>] VoicemailMediaInfo data, response status code and response headers - def get_messages_message_id_media_with_http_info(message_id, opts = {}) + # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers + def patch_userpolicies_user_id_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages_message_id_media ..." + @api_client.config.logger.debug "Calling API: VoicemailApi#patch_userpolicies_user_id ..." end - # verify the required parameter 'message_id' is set - fail "Missing the required parameter 'message_id' when calling get_messages_message_id_media" if message_id.nil? + # verify the required parameter 'user_id' is set + fail "Missing the required parameter 'user_id' when calling patch_userpolicies_user_id" if user_id.nil? - if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id']) - fail 'invalid value for "format_id", must be one of WEBM, WAV' - end + # verify the required parameter 'body' is set + fail "Missing the required parameter 'body' when calling patch_userpolicies_user_id" if body.nil? # resource path - path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) + path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} - query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) @@ -651,22 +651,22 @@ # form parameters form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] - data, status_code, headers = @api_client.call_api(:GET, path, + data, status_code, headers = @api_client.call_api(:PATCH, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'VoicemailMediaInfo') + :return_type => 'VoicemailUserPolicy') if @api_client.config.debugging - @api_client.config.logger.debug "API called: VoicemailApi#get_messages_message_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: VoicemailApi#patch_userpolicies_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end