services.h

Go to the documentation of this file.

#ifndef QEVERCLOUD_GENERATED_SERVICES_H
#define QEVERCLOUD_GENERATED_SERVICES_H

#include "../Optional.h"
#include "../export.h"
#include "../AsyncResult.h"
#include "constants.h"
#include "types.h"
#include <QMap>
#include <QList>
#include <QSet>
#include <QString>
#include <QStringList>
#include <QByteArray>
#include <QDateTime>
#include <QMetaType>
#include <QObject>

namespace qevercloud {

class QEVERCLOUD_EXPORT NoteStore: public QObject
{
    Q_DISABLE_COPY(NoteStore)
public:
    explicit NoteStore(QString noteStoreUrl = QString(), QString authenticationToken = QString(), QObject * parent = 0);
    explicit NoteStore(QObject * parent);

    void setNoteStoreUrl(QString noteStoreUrl) { m_url = noteStoreUrl; }
    QString noteStoreUrl() { return m_url; }

    void setAuthenticationToken(QString authenticationToken) { m_authenticationToken = authenticationToken; }
    QString authenticationToken() { return m_authenticationToken; }

    SyncState getSyncState(QString authenticationToken = QString());

    AsyncResult * getSyncStateAsync(QString authenticationToken = QString());

    SyncState getSyncStateWithMetrics(const ClientUsageMetrics& clientMetrics, QString authenticationToken = QString());

    AsyncResult * getSyncStateWithMetricsAsync(const ClientUsageMetrics& clientMetrics, QString authenticationToken = QString());

    SyncChunk getSyncChunk(qint32 afterUSN, qint32 maxEntries, bool fullSyncOnly, QString authenticationToken = QString());

    AsyncResult * getSyncChunkAsync(qint32 afterUSN, qint32 maxEntries, bool fullSyncOnly, QString authenticationToken = QString());

    SyncChunk getFilteredSyncChunk(qint32 afterUSN, qint32 maxEntries, const SyncChunkFilter& filter, QString authenticationToken = QString());

    AsyncResult * getFilteredSyncChunkAsync(qint32 afterUSN, qint32 maxEntries, const SyncChunkFilter& filter, QString authenticationToken = QString());

    SyncState getLinkedNotebookSyncState(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    AsyncResult * getLinkedNotebookSyncStateAsync(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    SyncChunk getLinkedNotebookSyncChunk(const LinkedNotebook& linkedNotebook, qint32 afterUSN, qint32 maxEntries, bool fullSyncOnly, QString authenticationToken = QString());

    AsyncResult * getLinkedNotebookSyncChunkAsync(const LinkedNotebook& linkedNotebook, qint32 afterUSN, qint32 maxEntries, bool fullSyncOnly, QString authenticationToken = QString());

    QList< Notebook > listNotebooks(QString authenticationToken = QString());

    AsyncResult * listNotebooksAsync(QString authenticationToken = QString());

    Notebook getNotebook(Guid guid, QString authenticationToken = QString());

    AsyncResult * getNotebookAsync(Guid guid, QString authenticationToken = QString());

    Notebook getDefaultNotebook(QString authenticationToken = QString());

    AsyncResult * getDefaultNotebookAsync(QString authenticationToken = QString());

    Notebook createNotebook(const Notebook& notebook, QString authenticationToken = QString());

    AsyncResult * createNotebookAsync(const Notebook& notebook, QString authenticationToken = QString());

    qint32 updateNotebook(const Notebook& notebook, QString authenticationToken = QString());

    AsyncResult * updateNotebookAsync(const Notebook& notebook, QString authenticationToken = QString());

    qint32 expungeNotebook(Guid guid, QString authenticationToken = QString());

    AsyncResult * expungeNotebookAsync(Guid guid, QString authenticationToken = QString());

    QList< Tag > listTags(QString authenticationToken = QString());

    AsyncResult * listTagsAsync(QString authenticationToken = QString());

    QList< Tag > listTagsByNotebook(Guid notebookGuid, QString authenticationToken = QString());

    AsyncResult * listTagsByNotebookAsync(Guid notebookGuid, QString authenticationToken = QString());

    Tag getTag(Guid guid, QString authenticationToken = QString());

    AsyncResult * getTagAsync(Guid guid, QString authenticationToken = QString());

    Tag createTag(const Tag& tag, QString authenticationToken = QString());

    AsyncResult * createTagAsync(const Tag& tag, QString authenticationToken = QString());

    qint32 updateTag(const Tag& tag, QString authenticationToken = QString());

    AsyncResult * updateTagAsync(const Tag& tag, QString authenticationToken = QString());

    void untagAll(Guid guid, QString authenticationToken = QString());

    AsyncResult * untagAllAsync(Guid guid, QString authenticationToken = QString());

    qint32 expungeTag(Guid guid, QString authenticationToken = QString());

    AsyncResult * expungeTagAsync(Guid guid, QString authenticationToken = QString());

    QList< SavedSearch > listSearches(QString authenticationToken = QString());

    AsyncResult * listSearchesAsync(QString authenticationToken = QString());

    SavedSearch getSearch(Guid guid, QString authenticationToken = QString());

    AsyncResult * getSearchAsync(Guid guid, QString authenticationToken = QString());

    SavedSearch createSearch(const SavedSearch& search, QString authenticationToken = QString());

    AsyncResult * createSearchAsync(const SavedSearch& search, QString authenticationToken = QString());

    qint32 updateSearch(const SavedSearch& search, QString authenticationToken = QString());

    AsyncResult * updateSearchAsync(const SavedSearch& search, QString authenticationToken = QString());

    qint32 expungeSearch(Guid guid, QString authenticationToken = QString());

    AsyncResult * expungeSearchAsync(Guid guid, QString authenticationToken = QString());

    NoteList findNotes(const NoteFilter& filter, qint32 offset, qint32 maxNotes, QString authenticationToken = QString());

    AsyncResult * findNotesAsync(const NoteFilter& filter, qint32 offset, qint32 maxNotes, QString authenticationToken = QString());

    qint32 findNoteOffset(const NoteFilter& filter, Guid guid, QString authenticationToken = QString());

    AsyncResult * findNoteOffsetAsync(const NoteFilter& filter, Guid guid, QString authenticationToken = QString());

    NotesMetadataList findNotesMetadata(const NoteFilter& filter, qint32 offset, qint32 maxNotes, const NotesMetadataResultSpec& resultSpec, QString authenticationToken = QString());

    AsyncResult * findNotesMetadataAsync(const NoteFilter& filter, qint32 offset, qint32 maxNotes, const NotesMetadataResultSpec& resultSpec, QString authenticationToken = QString());

    NoteCollectionCounts findNoteCounts(const NoteFilter& filter, bool withTrash, QString authenticationToken = QString());

    AsyncResult * findNoteCountsAsync(const NoteFilter& filter, bool withTrash, QString authenticationToken = QString());

    Note getNote(Guid guid, bool withContent, bool withResourcesData, bool withResourcesRecognition, bool withResourcesAlternateData, QString authenticationToken = QString());

    AsyncResult * getNoteAsync(Guid guid, bool withContent, bool withResourcesData, bool withResourcesRecognition, bool withResourcesAlternateData, QString authenticationToken = QString());

    LazyMap getNoteApplicationData(Guid guid, QString authenticationToken = QString());

    AsyncResult * getNoteApplicationDataAsync(Guid guid, QString authenticationToken = QString());

    QString getNoteApplicationDataEntry(Guid guid, QString key, QString authenticationToken = QString());

    AsyncResult * getNoteApplicationDataEntryAsync(Guid guid, QString key, QString authenticationToken = QString());

    qint32 setNoteApplicationDataEntry(Guid guid, QString key, QString value, QString authenticationToken = QString());

    AsyncResult * setNoteApplicationDataEntryAsync(Guid guid, QString key, QString value, QString authenticationToken = QString());

    qint32 unsetNoteApplicationDataEntry(Guid guid, QString key, QString authenticationToken = QString());

    AsyncResult * unsetNoteApplicationDataEntryAsync(Guid guid, QString key, QString authenticationToken = QString());

    QString getNoteContent(Guid guid, QString authenticationToken = QString());

    AsyncResult * getNoteContentAsync(Guid guid, QString authenticationToken = QString());

    QString getNoteSearchText(Guid guid, bool noteOnly, bool tokenizeForIndexing, QString authenticationToken = QString());

    AsyncResult * getNoteSearchTextAsync(Guid guid, bool noteOnly, bool tokenizeForIndexing, QString authenticationToken = QString());

    QString getResourceSearchText(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceSearchTextAsync(Guid guid, QString authenticationToken = QString());

    QStringList getNoteTagNames(Guid guid, QString authenticationToken = QString());

    AsyncResult * getNoteTagNamesAsync(Guid guid, QString authenticationToken = QString());

    Note createNote(const Note& note, QString authenticationToken = QString());

    AsyncResult * createNoteAsync(const Note& note, QString authenticationToken = QString());

    Note updateNote(const Note& note, QString authenticationToken = QString());

    AsyncResult * updateNoteAsync(const Note& note, QString authenticationToken = QString());

    qint32 deleteNote(Guid guid, QString authenticationToken = QString());

    AsyncResult * deleteNoteAsync(Guid guid, QString authenticationToken = QString());

    qint32 expungeNote(Guid guid, QString authenticationToken = QString());

    AsyncResult * expungeNoteAsync(Guid guid, QString authenticationToken = QString());

    qint32 expungeNotes(QList< Guid > noteGuids, QString authenticationToken = QString());

    AsyncResult * expungeNotesAsync(QList< Guid > noteGuids, QString authenticationToken = QString());

    qint32 expungeInactiveNotes(QString authenticationToken = QString());

    AsyncResult * expungeInactiveNotesAsync(QString authenticationToken = QString());

    Note copyNote(Guid noteGuid, Guid toNotebookGuid, QString authenticationToken = QString());

    AsyncResult * copyNoteAsync(Guid noteGuid, Guid toNotebookGuid, QString authenticationToken = QString());

    QList< NoteVersionId > listNoteVersions(Guid noteGuid, QString authenticationToken = QString());

    AsyncResult * listNoteVersionsAsync(Guid noteGuid, QString authenticationToken = QString());

    Note getNoteVersion(Guid noteGuid, qint32 updateSequenceNum, bool withResourcesData, bool withResourcesRecognition, bool withResourcesAlternateData, QString authenticationToken = QString());

    AsyncResult * getNoteVersionAsync(Guid noteGuid, qint32 updateSequenceNum, bool withResourcesData, bool withResourcesRecognition, bool withResourcesAlternateData, QString authenticationToken = QString());

    Resource getResource(Guid guid, bool withData, bool withRecognition, bool withAttributes, bool withAlternateData, QString authenticationToken = QString());

    AsyncResult * getResourceAsync(Guid guid, bool withData, bool withRecognition, bool withAttributes, bool withAlternateData, QString authenticationToken = QString());

    LazyMap getResourceApplicationData(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceApplicationDataAsync(Guid guid, QString authenticationToken = QString());

    QString getResourceApplicationDataEntry(Guid guid, QString key, QString authenticationToken = QString());

    AsyncResult * getResourceApplicationDataEntryAsync(Guid guid, QString key, QString authenticationToken = QString());

    qint32 setResourceApplicationDataEntry(Guid guid, QString key, QString value, QString authenticationToken = QString());

    AsyncResult * setResourceApplicationDataEntryAsync(Guid guid, QString key, QString value, QString authenticationToken = QString());

    qint32 unsetResourceApplicationDataEntry(Guid guid, QString key, QString authenticationToken = QString());

    AsyncResult * unsetResourceApplicationDataEntryAsync(Guid guid, QString key, QString authenticationToken = QString());

    qint32 updateResource(const Resource& resource, QString authenticationToken = QString());

    AsyncResult * updateResourceAsync(const Resource& resource, QString authenticationToken = QString());

    QByteArray getResourceData(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceDataAsync(Guid guid, QString authenticationToken = QString());

    Resource getResourceByHash(Guid noteGuid, QByteArray contentHash, bool withData, bool withRecognition, bool withAlternateData, QString authenticationToken = QString());

    AsyncResult * getResourceByHashAsync(Guid noteGuid, QByteArray contentHash, bool withData, bool withRecognition, bool withAlternateData, QString authenticationToken = QString());

    QByteArray getResourceRecognition(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceRecognitionAsync(Guid guid, QString authenticationToken = QString());

    QByteArray getResourceAlternateData(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceAlternateDataAsync(Guid guid, QString authenticationToken = QString());

    ResourceAttributes getResourceAttributes(Guid guid, QString authenticationToken = QString());

    AsyncResult * getResourceAttributesAsync(Guid guid, QString authenticationToken = QString());

    Notebook getPublicNotebook(UserID userId, QString publicUri);

    AsyncResult * getPublicNotebookAsync(UserID userId, QString publicUri);

    SharedNotebook createSharedNotebook(const SharedNotebook& sharedNotebook, QString authenticationToken = QString());

    AsyncResult * createSharedNotebookAsync(const SharedNotebook& sharedNotebook, QString authenticationToken = QString());

    qint32 updateSharedNotebook(const SharedNotebook& sharedNotebook, QString authenticationToken = QString());

    AsyncResult * updateSharedNotebookAsync(const SharedNotebook& sharedNotebook, QString authenticationToken = QString());

    qint32 setSharedNotebookRecipientSettings(qint64 sharedNotebookId, const SharedNotebookRecipientSettings& recipientSettings, QString authenticationToken = QString());

    AsyncResult * setSharedNotebookRecipientSettingsAsync(qint64 sharedNotebookId, const SharedNotebookRecipientSettings& recipientSettings, QString authenticationToken = QString());

    qint32 sendMessageToSharedNotebookMembers(Guid notebookGuid, QString messageText, QStringList recipients, QString authenticationToken = QString());

    AsyncResult * sendMessageToSharedNotebookMembersAsync(Guid notebookGuid, QString messageText, QStringList recipients, QString authenticationToken = QString());

    QList< SharedNotebook > listSharedNotebooks(QString authenticationToken = QString());

    AsyncResult * listSharedNotebooksAsync(QString authenticationToken = QString());

    qint32 expungeSharedNotebooks(QList< qint64 > sharedNotebookIds, QString authenticationToken = QString());

    AsyncResult * expungeSharedNotebooksAsync(QList< qint64 > sharedNotebookIds, QString authenticationToken = QString());

    LinkedNotebook createLinkedNotebook(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    AsyncResult * createLinkedNotebookAsync(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    qint32 updateLinkedNotebook(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    AsyncResult * updateLinkedNotebookAsync(const LinkedNotebook& linkedNotebook, QString authenticationToken = QString());

    QList< LinkedNotebook > listLinkedNotebooks(QString authenticationToken = QString());

    AsyncResult * listLinkedNotebooksAsync(QString authenticationToken = QString());

    qint32 expungeLinkedNotebook(Guid guid, QString authenticationToken = QString());

    AsyncResult * expungeLinkedNotebookAsync(Guid guid, QString authenticationToken = QString());

    AuthenticationResult authenticateToSharedNotebook(QString shareKey, QString authenticationToken = QString());

    AsyncResult * authenticateToSharedNotebookAsync(QString shareKey, QString authenticationToken = QString());

    SharedNotebook getSharedNotebookByAuth(QString authenticationToken = QString());

    AsyncResult * getSharedNotebookByAuthAsync(QString authenticationToken = QString());

    void emailNote(const NoteEmailParameters& parameters, QString authenticationToken = QString());

    AsyncResult * emailNoteAsync(const NoteEmailParameters& parameters, QString authenticationToken = QString());

    QString shareNote(Guid guid, QString authenticationToken = QString());

    AsyncResult * shareNoteAsync(Guid guid, QString authenticationToken = QString());

    void stopSharingNote(Guid guid, QString authenticationToken = QString());

    AsyncResult * stopSharingNoteAsync(Guid guid, QString authenticationToken = QString());

    AuthenticationResult authenticateToSharedNote(QString guid, QString noteKey, QString authenticationToken = QString());

    AsyncResult * authenticateToSharedNoteAsync(QString guid, QString noteKey, QString authenticationToken = QString());

    RelatedResult findRelated(const RelatedQuery& query, const RelatedResultSpec& resultSpec, QString authenticationToken = QString());

    AsyncResult * findRelatedAsync(const RelatedQuery& query, const RelatedResultSpec& resultSpec, QString authenticationToken = QString());

private:
    QString m_url;
    QString m_authenticationToken;
};

class QEVERCLOUD_EXPORT UserStore: public QObject
{
    Q_DISABLE_COPY(UserStore)
public:
    explicit UserStore(QString host, QString authenticationToken = QString(), QObject * parent = 0);

    void setAuthenticationToken(QString authenticationToken) { m_authenticationToken = authenticationToken; }
    QString authenticationToken() { return m_authenticationToken; }

    bool checkVersion(QString clientName, qint16 edamVersionMajor = EDAM_VERSION_MAJOR, qint16 edamVersionMinor = EDAM_VERSION_MINOR);

    AsyncResult * checkVersionAsync(QString clientName, qint16 edamVersionMajor = EDAM_VERSION_MAJOR, qint16 edamVersionMinor = EDAM_VERSION_MINOR);

    BootstrapInfo getBootstrapInfo(QString locale);

    AsyncResult * getBootstrapInfoAsync(QString locale);

    AuthenticationResult authenticate(QString username, QString password, QString consumerKey, QString consumerSecret, bool supportsTwoFactor);

    AsyncResult * authenticateAsync(QString username, QString password, QString consumerKey, QString consumerSecret, bool supportsTwoFactor);

    AuthenticationResult authenticateLongSession(QString username, QString password, QString consumerKey, QString consumerSecret, QString deviceIdentifier, QString deviceDescription, bool supportsTwoFactor);

    AsyncResult * authenticateLongSessionAsync(QString username, QString password, QString consumerKey, QString consumerSecret, QString deviceIdentifier, QString deviceDescription, bool supportsTwoFactor);

    AuthenticationResult completeTwoFactorAuthentication(QString oneTimeCode, QString deviceIdentifier, QString deviceDescription, QString authenticationToken = QString());

    AsyncResult * completeTwoFactorAuthenticationAsync(QString oneTimeCode, QString deviceIdentifier, QString deviceDescription, QString authenticationToken = QString());

    void revokeLongSession(QString authenticationToken = QString());

    AsyncResult * revokeLongSessionAsync(QString authenticationToken = QString());

    AuthenticationResult authenticateToBusiness(QString authenticationToken = QString());

    AsyncResult * authenticateToBusinessAsync(QString authenticationToken = QString());

    AuthenticationResult refreshAuthentication(QString authenticationToken = QString());

    AsyncResult * refreshAuthenticationAsync(QString authenticationToken = QString());

    User getUser(QString authenticationToken = QString());

    AsyncResult * getUserAsync(QString authenticationToken = QString());

    PublicUserInfo getPublicUserInfo(QString username);

    AsyncResult * getPublicUserInfoAsync(QString username);

    PremiumInfo getPremiumInfo(QString authenticationToken = QString());

    AsyncResult * getPremiumInfoAsync(QString authenticationToken = QString());

    QString getNoteStoreUrl(QString authenticationToken = QString());

    AsyncResult * getNoteStoreUrlAsync(QString authenticationToken = QString());

private:
    QString m_url;
    QString m_authenticationToken;
};

} // namespace qevercloud
Q_DECLARE_METATYPE(QList< qevercloud::Notebook >)
Q_DECLARE_METATYPE(QList< qevercloud::Tag >)
Q_DECLARE_METATYPE(QList< qevercloud::SavedSearch >)
Q_DECLARE_METATYPE(QList< qevercloud::NoteVersionId >)
Q_DECLARE_METATYPE(QList< qevercloud::SharedNotebook >)
Q_DECLARE_METATYPE(QList< qevercloud::LinkedNotebook >)

#endif // QEVERCLOUD_GENERATED_SERVICES_H