lib/purecloudplatformclientv2/api/voicemail_api.rb in purecloudplatformclientv2-8.0.0 vs lib/purecloudplatformclientv2/api/voicemail_api.rb in purecloudplatformclientv2-9.0.0

- old
+ new

@@ -41,12 +41,19 @@ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_voicemail_message_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_message ..." end + + # verify the required parameter 'message_id' is set fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.delete_voicemail_message" if message_id.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} @@ -65,11 +72,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -95,10 +103,11 @@ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_voicemail_messages_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_messages ..." end + # resource path local_var_path = "/api/v2/voicemail/messages".sub('{format}','json') # query parameters query_params = {} @@ -117,11 +126,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -149,12 +159,19 @@ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers def get_voicemail_group_mailbox_with_http_info(group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_mailbox ..." end + + # verify the required parameter 'group_id' is set fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_mailbox" if group_id.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/groups/{groupId}/mailbox".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s) # query parameters query_params = {} @@ -173,11 +190,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -210,12 +228,31 @@ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers def get_voicemail_group_messages_with_http_info(group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_messages ..." end + + # verify the required parameter 'group_id' is set fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_messages" if group_id.nil? + + + + + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/voicemail/groups/{groupId}/messages".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s) # query parameters query_params = {} @@ -236,11 +273,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -269,12 +307,19 @@ # @return [Array<(VoicemailGroupPolicy, Fixnum, Hash)>] VoicemailGroupPolicy data, response status code and response headers def get_voicemail_group_policy_with_http_info(group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_policy ..." end + + # verify the required parameter 'group_id' is set fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_policy" if group_id.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s) # query parameters query_params = {} @@ -293,11 +338,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -324,10 +370,11 @@ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers def get_voicemail_mailbox_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_mailbox ..." end + # resource path local_var_path = "/api/v2/voicemail/mailbox".sub('{format}','json') # query parameters query_params = {} @@ -346,11 +393,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -377,10 +425,11 @@ # @return [Array<(VoicemailMailboxInfo, Fixnum, Hash)>] VoicemailMailboxInfo data, response status code and response headers def get_voicemail_me_mailbox_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_mailbox ..." end + # resource path local_var_path = "/api/v2/voicemail/me/mailbox".sub('{format}','json') # query parameters query_params = {} @@ -399,11 +448,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -434,10 +484,23 @@ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers def get_voicemail_me_messages_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_messages ..." end + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/voicemail/me/messages".sub('{format}','json') # query parameters query_params = {} @@ -458,11 +521,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -489,10 +553,11 @@ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers def get_voicemail_me_policy_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_policy ..." end + # resource path local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json') # query parameters query_params = {} @@ -511,11 +576,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -546,12 +612,25 @@ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers def get_voicemail_message_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message ..." end + + # verify the required parameter 'message_id' is set fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message" if message_id.nil? + + + + + + + + + + + # resource path local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} @@ -571,11 +650,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -606,15 +686,29 @@ # @return [Array<(VoicemailMediaInfo, Fixnum, Hash)>] VoicemailMediaInfo data, response status code and response headers def get_voicemail_message_media_with_http_info(message_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message_media ..." end + + # verify the required parameter 'message_id' is set fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message_media" if message_id.nil? + + + + + + + + if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id']) fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE' end + + + + # resource path local_var_path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} @@ -634,11 +728,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -669,10 +764,23 @@ # @return [Array<(VoicemailMessageEntityListing, Fixnum, Hash)>] VoicemailMessageEntityListing data, response status code and response headers def get_voicemail_messages_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_messages ..." end + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/voicemail/messages".sub('{format}','json') # query parameters query_params = {} @@ -693,11 +801,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -724,10 +833,11 @@ # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers def get_voicemail_policy_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_policy ..." end + # resource path local_var_path = "/api/v2/voicemail/policy".sub('{format}','json') # query parameters query_params = {} @@ -746,11 +856,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -781,12 +892,25 @@ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers def get_voicemail_search_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_search ..." end + + # verify the required parameter 'q64' is set fail ArgumentError, "Missing the required parameter 'q64' when calling VoicemailApi.get_voicemail_search" if q64.nil? + + + + + + + + + + + # resource path local_var_path = "/api/v2/voicemail/search".sub('{format}','json') # query parameters query_params = {} @@ -807,11 +931,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -840,12 +965,19 @@ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers def get_voicemail_userpolicy_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_userpolicy ..." end + + # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.get_voicemail_userpolicy" if user_id.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} @@ -864,11 +996,12 @@ # form parameters form_params = {} # http body (model) post_body = nil - auth_names = ['PureCloud Auth'] + + auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -899,14 +1032,27 @@ # @return [Array<(VoicemailGroupPolicy, Fixnum, Hash)>] VoicemailGroupPolicy data, response status code and response headers def patch_voicemail_group_policy_with_http_info(group_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_group_policy ..." end + + # verify the required parameter 'group_id' is set fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.patch_voicemail_group_policy" if group_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_group_policy" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s) # query parameters query_params = {} @@ -925,10 +1071,11 @@ # 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, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -958,12 +1105,19 @@ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers def patch_voicemail_me_policy_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_me_policy ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_me_policy" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json') # query parameters query_params = {} @@ -982,10 +1136,11 @@ # 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, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1017,14 +1172,27 @@ # @return [Array<(VoicemailUserPolicy, Fixnum, Hash)>] VoicemailUserPolicy data, response status code and response headers def patch_voicemail_userpolicy_with_http_info(user_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_userpolicy ..." end + + # verify the required parameter 'user_id' is set fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.patch_voicemail_userpolicy" if user_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_userpolicy" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s) # query parameters query_params = {} @@ -1043,10 +1211,11 @@ # 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, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1076,10 +1245,17 @@ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers def post_voicemail_messages_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_messages ..." end + + + + + + + # resource path local_var_path = "/api/v2/voicemail/messages".sub('{format}','json') # query parameters query_params = {} @@ -1098,10 +1274,11 @@ # 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(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1131,12 +1308,19 @@ # @return [Array<(VoicemailsSearchResponse, Fixnum, Hash)>] VoicemailsSearchResponse data, response status code and response headers def post_voicemail_search_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_search ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.post_voicemail_search" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/search".sub('{format}','json') # query parameters query_params = {} @@ -1155,10 +1339,11 @@ # 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(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1190,14 +1375,27 @@ # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers def put_voicemail_message_with_http_info(message_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_message ..." end + + # verify the required parameter 'message_id' is set fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.put_voicemail_message" if message_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_message" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s) # query parameters query_params = {} @@ -1216,10 +1414,11 @@ # 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(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, @@ -1249,12 +1448,19 @@ # @return [Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>] VoicemailOrganizationPolicy data, response status code and response headers def put_voicemail_policy_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_policy ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_policy" if body.nil? + + + + + # resource path local_var_path = "/api/v2/voicemail/policy".sub('{format}','json') # query parameters query_params = {} @@ -1273,9 +1479,10 @@ # 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(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params,