/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include "converters.h"
#include "csapi/definitions/sync_filter.h"

namespace QMatrixClient {
    // Operations

    /// Upload a new filter.
    ///
    /// Uploads a new filter definition to the homeserver.
    /// Returns a filter ID that may be used in future requests to
    /// restrict which events are returned to the client.
    class DefineFilterJob : public BaseJob
    {
        public:
        /*! Upload a new filter.
         * \param userId
         *   The id of the user uploading the filter. The access token must be
         * authorized to make requests for this user id. \param filter Uploads a
         * new filter definition to the homeserver. Returns a filter ID that may
         * be used in future requests to restrict which events are returned to
         * the client.
         */
        explicit DefineFilterJob(const QString& userId, const Filter& filter);
        ~DefineFilterJob() override;

        // Result properties

        /// The ID of the filter that was created. Cannot start
        /// with a ``{`` as this character is used to determine
        /// if the filter provided is inline JSON or a previously
        /// declared filter by homeservers on some APIs.
        const QString& filterId() const;

        protected:
        Status parseJson(const QJsonDocument& data) override;

        private:
        class Private;
        QScopedPointer<Private> d;
    };

    /// Download a filter
    class GetFilterJob : public BaseJob
    {
        public:
        /*! Download a filter
         * \param userId
         *   The user ID to download a filter for.
         * \param filterId
         *   The filter ID to download.
         */
        explicit GetFilterJob(const QString& userId, const QString& filterId);

        /*! Construct a URL without creating a full-fledged job object
         *
         * This function can be used when a URL for
         * GetFilterJob is necessary but the job
         * itself isn't.
         */
        static QUrl makeRequestUrl(QUrl baseUrl, const QString& userId,
                                   const QString& filterId);

        ~GetFilterJob() override;

        // Result properties

        /// "The filter defintion"
        const Filter& data() const;

        protected:
        Status parseJson(const QJsonDocument& data) override;

        private:
        class Private;
        QScopedPointer<Private> d;
    };
} // namespace QMatrixClient