/*
    SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>

    SPDX-License-Identifier: MIT
*/

#ifndef KUSERFEEDBACK_CONSOLE_RESTAPI_H
#define KUSERFEEDBACK_CONSOLE_RESTAPI_H

#include <QVector>

class QNetworkReply;

namespace KUserFeedback {
namespace Console {

class Product;
class RESTClient;
class Sample;
class Survey;

/** C++ wrapper for the server-side API.
 *  Precondition for all methods is that client->isConnected() returns @c true.
 */
namespace RESTApi
{
    /** Check if server database schema is up-to-date. */
    QNetworkReply* checkSchema(RESTClient *client);

    /** List all products. */
    QNetworkReply* listProducts(RESTClient *client);

    /** Add a new product.
     *  @param p The product to add. Must be valid.
     */
    QNetworkReply* createProduct(RESTClient *client, const Product &p);

    /** Update an existing product.
     *  @param p The product to add. Must be valid.
     */
    QNetworkReply* updateProduct(RESTClient *client, const Product &p);

    /** Deletes a product.
     *  @param p The product to add. Must be valid.
     */
    QNetworkReply* deleteProduct(RESTClient *client, const Product &p);

    /** Get all samples for a product.
     *  @param p The product to add. Must be valid.
     */
    QNetworkReply* listSamples(RESTClient *client, const Product &p);

    /** Add the given samples to a product.
     *  @param p The product to add. Must be valid.
     */
    QNetworkReply* addSamples(RESTClient *client, const Product &p, const QVector<Sample> &samples);

    /** List all surveys for product @p p. */
    QNetworkReply* listSurveys(RESTClient *client, const Product &p);

    /** Create a new survey. */
    QNetworkReply* createSurvey(RESTClient *client, const Product &p, const Survey &s);

    /** Update an existing survey. */
    QNetworkReply* updateSurvey(RESTClient *client, const Survey &s);

    /** Delete a survey. */
    QNetworkReply* deleteSurvey(RESTClient *client, const Survey &s);
}

}
}

#endif // KUSERFEEDBACK_CONSOLE_RESTAPI_H