lib/purecloudplatformclientv2/api/analytics_api.rb in purecloudplatformclientv2-8.0.0 vs lib/purecloudplatformclientv2/api/analytics_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_analytics_reporting_schedule_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_reporting_schedule ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.delete_analytics_reporting_schedule" if schedule_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_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, @@ -97,12 +105,19 @@ # @return [Array<(AnalyticsConversation, Fixnum, Hash)>] AnalyticsConversation data, response status code and response headers def get_analytics_conversation_details_with_http_info(conversation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_conversation_details ..." end + + # verify the required parameter 'conversation_id' is set fail ArgumentError, "Missing the required parameter 'conversation_id' when calling AnalyticsApi.get_analytics_conversation_details" if conversation_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/conversations/{conversationId}/details".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s) # query parameters query_params = {} @@ -121,11 +136,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, @@ -158,10 +174,29 @@ # @return [Array<(ReportMetaDataEntityListing, Fixnum, Hash)>] ReportMetaDataEntityListing data, response status code and response headers def get_analytics_reporting_metadata_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_metadata ..." end + + + + + + + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/metadata".sub('{format}','json') # query parameters query_params = {} @@ -183,11 +218,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, @@ -218,12 +254,25 @@ # @return [Array<(ReportMetaData, Fixnum, Hash)>] ReportMetaData data, response status code and response headers def get_analytics_reporting_report_id_metadata_with_http_info(report_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_report_id_metadata ..." end + + # verify the required parameter 'report_id' is set fail ArgumentError, "Missing the required parameter 'report_id' when calling AnalyticsApi.get_analytics_reporting_report_id_metadata" if report_id.nil? + + + + + + + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/{reportId}/metadata".sub('{format}','json').sub('{' + 'reportId' + '}', report_id.to_s) # query parameters query_params = {} @@ -243,11 +292,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, @@ -274,10 +324,11 @@ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers def get_analytics_reporting_reportformats_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_reportformats ..." end + # resource path local_var_path = "/api/v2/analytics/reporting/reportformats".sub('{format}','json') # query parameters query_params = {} @@ -296,11 +347,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, @@ -329,12 +381,19 @@ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers def get_analytics_reporting_schedule_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule" if schedule_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -353,11 +412,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, @@ -390,12 +450,31 @@ # @return [Array<(ReportRunEntryEntityDomainListing, Fixnum, Hash)>] ReportRunEntryEntityDomainListing data, response status code and response headers def get_analytics_reporting_schedule_history_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule_history ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history" if schedule_id.nil? + + + + + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -416,11 +495,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, @@ -449,12 +529,19 @@ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers def get_analytics_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule_history_latest ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_latest" if schedule_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -473,11 +560,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, @@ -508,14 +596,27 @@ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers def get_analytics_reporting_schedule_history_run_id_with_http_info(run_id, schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedule_history_run_id ..." end + + # verify the required parameter 'run_id' is set fail ArgumentError, "Missing the required parameter 'run_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_run_id" if run_id.nil? + + + + + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.get_analytics_reporting_schedule_history_run_id" if schedule_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}".sub('{format}','json').sub('{' + 'runId' + '}', run_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -534,11 +635,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, @@ -569,10 +671,23 @@ # @return [Array<(ReportScheduleEntityListing, Fixnum, Hash)>] ReportScheduleEntityListing data, response status code and response headers def get_analytics_reporting_schedules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_schedules ..." end + + + + + + + + + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules".sub('{format}','json') # query parameters query_params = {} @@ -593,11 +708,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, @@ -624,10 +740,11 @@ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers def get_analytics_reporting_timeperiods_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_reporting_timeperiods ..." end + # resource path local_var_path = "/api/v2/analytics/reporting/timeperiods".sub('{format}','json') # query parameters query_params = {} @@ -646,11 +763,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, @@ -681,14 +799,27 @@ # @return [Array<(PropertyIndexRequest, Fixnum, Hash)>] PropertyIndexRequest data, response status code and response headers def post_analytics_conversation_details_properties_with_http_info(conversation_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversation_details_properties ..." end + + # verify the required parameter 'conversation_id' is set fail ArgumentError, "Missing the required parameter 'conversation_id' when calling AnalyticsApi.post_analytics_conversation_details_properties" if conversation_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversation_details_properties" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/conversations/{conversationId}/details/properties".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s) # query parameters query_params = {} @@ -707,10 +838,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, @@ -740,12 +872,19 @@ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers def post_analytics_conversations_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_aggregates_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_aggregates_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/conversations/aggregates/query".sub('{format}','json') # query parameters query_params = {} @@ -764,10 +903,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, @@ -797,12 +937,19 @@ # @return [Array<(AnalyticsConversationQueryResponse, Fixnum, Hash)>] AnalyticsConversationQueryResponse data, response status code and response headers def post_analytics_conversations_details_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_conversations_details_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_conversations_details_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/conversations/details/query".sub('{format}','json') # query parameters query_params = {} @@ -821,10 +968,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, @@ -854,12 +1002,19 @@ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers def post_analytics_evaluations_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_evaluations_aggregates_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_evaluations_aggregates_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/evaluations/aggregates/query".sub('{format}','json') # query parameters query_params = {} @@ -878,10 +1033,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, @@ -911,12 +1067,19 @@ # @return [Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>] QualifierMappingObservationQueryResponse data, response status code and response headers def post_analytics_queues_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_queues_observations_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_queues_observations_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/queues/observations/query".sub('{format}','json') # query parameters query_params = {} @@ -935,10 +1098,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, @@ -968,12 +1132,19 @@ # @return [Array<(RunNowResponse, Fixnum, Hash)>] RunNowResponse data, response status code and response headers def post_analytics_reporting_schedule_runreport_with_http_info(schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_schedule_runreport ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.post_analytics_reporting_schedule_runreport" if schedule_id.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}/runreport".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -992,11 +1163,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(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, @@ -1025,12 +1197,19 @@ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers def post_analytics_reporting_schedules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_reporting_schedules ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_reporting_schedules" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules".sub('{format}','json') # query parameters query_params = {} @@ -1049,10 +1228,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, @@ -1082,12 +1262,19 @@ # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers def post_analytics_users_aggregates_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_aggregates_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_aggregates_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json') # query parameters query_params = {} @@ -1106,10 +1293,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, @@ -1139,12 +1327,19 @@ # @return [Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse data, response status code and response headers def post_analytics_users_details_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_details_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_details_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json') # query parameters query_params = {} @@ -1163,10 +1358,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, @@ -1196,12 +1392,19 @@ # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers def post_analytics_users_observations_query_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_observations_query ..." end + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_observations_query" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/users/observations/query".sub('{format}','json') # query parameters query_params = {} @@ -1220,10 +1423,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, @@ -1255,14 +1459,27 @@ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers def put_analytics_reporting_schedule_with_http_info(schedule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AnalyticsApi.put_analytics_reporting_schedule ..." end + + # verify the required parameter 'schedule_id' is set fail ArgumentError, "Missing the required parameter 'schedule_id' when calling AnalyticsApi.put_analytics_reporting_schedule" if schedule_id.nil? + + + + + + # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.put_analytics_reporting_schedule" if body.nil? + + + + + # resource path local_var_path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s) # query parameters query_params = {} @@ -1281,9 +1498,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,