require "uri" module PureCloud class VoicemailApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Get a user's voicemail policy # # @param user_id User ID # @param [Hash] opts the optional parameters # @return [VoicemailUserPolicy] def get_configuration_uservoicemailpolicie(user_id, opts = {}) data, status_code, headers = get_configuration_uservoicemailpolicie_with_http_info(user_id, opts) return data end # Get a user's voicemail policy # # @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_configuration_uservoicemailpolicie_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_configuration_uservoicemailpolicie ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling get_configuration_uservoicemailpolicie" if user_id.nil? # resource path path = "/api/v1/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#get_configuration_uservoicemailpolicie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a user's voicemail policy # # @param user_id User ID # @param body The user's voicemail policy # @param [Hash] opts the optional parameters # @return [VoicemailUserPolicy] def patch_configuration_uservoicemailpolicie(user_id, body, opts = {}) data, status_code, headers = patch_configuration_uservoicemailpolicie_with_http_info(user_id, body, opts) return data end # Update a user's voicemail policy # # @param user_id User ID # @param body The user's voicemail policy # @param [Hash] opts the optional parameters # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers def patch_configuration_uservoicemailpolicie_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#patch_configuration_uservoicemailpolicie ..." end # verify the required parameter 'user_id' is set fail "Missing the required parameter 'user_id' when calling patch_configuration_uservoicemailpolicie" if user_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling patch_configuration_uservoicemailpolicie" if body.nil? # resource path path = "/api/v1/configuration/uservoicemailpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'VoicemailUserPolicy') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#patch_configuration_uservoicemailpolicie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a policy # # @param [Hash] opts the optional parameters # @return [VoicemailOrganizationPolicy] def get_configuration_voicemailpolicy(opts = {}) data, status_code, headers = get_configuration_voicemailpolicy_with_http_info(opts) return data end # Get a policy # # @param [Hash] opts the optional parameters # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers def get_configuration_voicemailpolicy_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_configuration_voicemailpolicy ..." end # resource path path = "/api/v1/configuration/voicemailpolicy".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#get_configuration_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a policy # # @param [Hash] opts the optional parameters # @option opts [VoicemailOrganizationPolicy] :body Policy # @return [VoicemailOrganizationPolicy] def put_configuration_voicemailpolicy(opts = {}) data, status_code, headers = put_configuration_voicemailpolicy_with_http_info(opts) return data end # Update a policy # # @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_configuration_voicemailpolicy_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#put_configuration_voicemailpolicy ..." end # resource path path = "/api/v1/configuration/voicemailpolicy".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud Auth'] 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 => 'VoicemailOrganizationPolicy') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#put_configuration_voicemailpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get mailbox information # # @param [Hash] opts the optional parameters # @return [VoicemailMailboxInfo] def get_mailbox(opts = {}) data, status_code, headers = get_mailbox_with_http_info(opts) return data end # Get mailbox information # # @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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_mailbox ..." end # resource path path = "/api/v1/voicemail/mailbox".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'VoicemailMailboxInfo') if @api_client.config.debugging @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 # List voicemail messages # # @param [Hash] opts the optional parameters # @return [VoicemailMessageEntityListing] def get_messages(opts = {}) data, status_code, headers = get_messages_with_http_info(opts) return data end # List voicemail messages # # @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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_messages ..." end # resource path path = "/api/v1/voicemail/messages".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'VoicemailMessageEntityListing') if @api_client.config.debugging @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 # Delete all voicemail messages # # @param [Hash] opts the optional parameters # @return [String] def delete_messages(opts = {}) data, status_code, headers = delete_messages_with_http_info(opts) return data end # Delete all voicemail messages # # @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 = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#delete_messages ..." end # resource path path = "/api/v1/voicemail/messages".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'String') if @api_client.config.debugging @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 # Get message. # # @param message_id Message ID # @param [Hash] opts the optional parameters # @return [VoicemailMessage] def get_message(message_id, opts = {}) data, status_code, headers = get_message_with_http_info(message_id, opts) return data end # Get message. # # @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_message_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_message ..." end # verify the required parameter 'message_id' is set fail "Missing the required parameter 'message_id' when calling get_message" if message_id.nil? # resource path path = "/api/v1/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'VoicemailMessage') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#get_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a message. # # @param message_id Message ID # @param [Hash] opts the optional parameters # @option opts [VoicemailMessage] :body VoicemailMessage # @return [VoicemailMessage] def put_message(message_id, opts = {}) data, status_code, headers = put_message_with_http_info(message_id, opts) return data end # Update a message. # # @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_message_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#put_message ..." end # verify the required parameter 'message_id' is set fail "Missing the required parameter 'message_id' when calling put_message" if message_id.nil? # resource path path = "/api/v1/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud Auth'] 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 => 'VoicemailMessage') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#put_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete a message. # # @param message_id Message ID # @param [Hash] opts the optional parameters # @return [String] def delete_message(message_id, opts = {}) data, status_code, headers = delete_message_with_http_info(message_id, opts) return data end # Delete a 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_message_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#delete_message ..." end # verify the required parameter 'message_id' is set fail "Missing the required parameter 'message_id' when calling delete_message" if message_id.nil? # resource path path = "/api/v1/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#delete_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get media playback URI for this message # # @param message_id Message ID # @param [Hash] opts the optional parameters # @option opts [String] :format_id The desired format (WEBM, WAV, etc.) # @return [VoicemailMediaInfo] def get_message_media(message_id, opts = {}) data, status_code, headers = get_message_media_with_http_info(message_id, opts) return data end # Get media playback URI for this message # # @param message_id Message ID # @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_message_media_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi#get_message_media ..." end # verify the required parameter 'message_id' is set fail "Missing the required parameter 'message_id' when calling get_message_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/v1/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) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'VoicemailMediaInfo') if @api_client.config.debugging @api_client.config.logger.debug "API called: VoicemailApi#get_message_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end