/*
 * Copyright (c) 2018 - 2023, Entgra (Pvt) Ltd. (http://www.entgra.io) All Rights Reserved.
 *
 * Entgra (Pvt) Ltd. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package io.entgra.device.mgt.core.analytics.mgt.grafana.proxy.core.service;

import com.google.gson.JsonObject;
import io.entgra.device.mgt.core.analytics.mgt.grafana.proxy.common.exception.GrafanaManagementException;
import io.entgra.device.mgt.core.analytics.mgt.grafana.proxy.core.service.bean.Datasource;

import java.io.IOException;

public interface GrafanaAPIService {

    /**
     * Get predefined query template from grafana for given panel/variable
     * @param dashboardUID
     * @param panelId
     * @param refId
     * @param requestScheme
     * @return query of the given panel/variable
     * @throws IOException
     * @throws GrafanaManagementException
     */
    String getQueryTemplate(String dashboardUID, String panelId, String refId,
                            String requestScheme) throws IOException, GrafanaManagementException;

    /**
     * Get panel details by dashboard uid and panel Id
     * @param dashboardUID
     * @param panelId
     * @param requestScheme
     * @return Panel details
     * @throws IOException
     * @throws GrafanaManagementException
     */
    JsonObject getPanelDetails(String dashboardUID, String panelId, String requestScheme) throws
            IOException, GrafanaManagementException;

    /**
     * Get dashboard details by uid
     * @param dashboardUID
     * @param requestScheme
     * @return Dashboard details
     * @throws IOException
     * @throws GrafanaManagementException
     */
    JsonObject getDashboardDetails(String dashboardUID, String requestScheme) throws IOException,
            GrafanaManagementException;

    /**
     * Get datasource details by id
     * @param datasourceId
     * @param requestScheme
     * @return Datasource details
     * @throws IOException
     * @throws GrafanaManagementException
     */
    Datasource getDatasource(int datasourceId, String requestScheme) throws IOException,
            GrafanaManagementException;
}
