/*
 * Copyright (C) 2016 Canonical Ltd.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2 or version 3 of the License.
 * See http://www.gnu.org/copyleft/lgpl.html the full text of the license.
 */

#ifndef __SNAPD_ERROR_H__
#define __SNAPD_ERROR_H__

#if !defined(__SNAPD_GLIB_INSIDE__) && !defined(SNAPD_COMPILATION)
#error "Only <snapd-glib/snapd-glib.h> can be included directly."
#endif

#include <glib-object.h>

G_BEGIN_DECLS

/**
 * SnapdError:
 * @SNAPD_ERROR_CONNECTION_FAILED: not able to connect to snapd.
 * @SNAPD_ERROR_WRITE_FAILED: an error occurred while writing to snapd.
 * @SNAPD_ERROR_READ_FAILED: an error occurred while reading from snapd.
 * @SNAPD_ERROR_BAD_REQUEST: snapd did not understand the request that was sent.
 * @SNAPD_ERROR_BAD_RESPONSE: the response received from snapd was not
 *     understood.
 * @SNAPD_ERROR_AUTH_DATA_REQUIRED: the requested operation requires
 *     authorization data.
 * @SNAPD_ERROR_AUTH_DATA_INVALID: the provided authorization data is invalid.
 * @SNAPD_ERROR_TWO_FACTOR_REQUIRED: login requires a two factor code.
 * @SNAPD_ERROR_TWO_FACTOR_INVALID: the two factor code provided at login is
 *     invalid.
 * @SNAPD_ERROR_PERMISSION_DENIED: this user account is not permitted to perform
 *     the requested operation.
 * @SNAPD_ERROR_FAILED: an unspecified error occurred while communicating
 *     with snapd.
 * @SNAPD_ERROR_TERMS_NOT_ACCEPTED: this user has not accepted the store's terms
 *     of service.
 * @SNAPD_ERROR_PAYMENT_NOT_SETUP: this user has not configured a payment
 *     method.
 * @SNAPD_ERROR_PAYMENT_DECLINED: this user has had their payment method
 *     declined by the payment provider.
 * @SNAPD_ERROR_ALREADY_INSTALLED: the requested snap is already installed.
 * @SNAPD_ERROR_NOT_INSTALLED: the requested snap is not installed.
 * @SNAPD_ERROR_NO_UPDATE_AVAILABLE: no update is available for this snap.
 * @SNAPD_ERROR_PASSWORD_POLICY_ERROR: provided password is not valid.
 * @SNAPD_ERROR_NEEDS_DEVMODE: this snap needs to be installed using devmode.
 * @SNAPD_ERROR_NEEDS_CLASSIC: this snap needs to be installed using classic
 *     mode.
 * @SNAPD_ERROR_NEEDS_CLASSIC_SYSTEM: a classic system is required to install
 *    this snap.
 * @SNAPD_ERROR_BAD_QUERY: a bad query was provided.
 * @SNAPD_ERROR_NETWORK_TIMEOUT: A timeout occurred during the request.
 * @SNAPD_ERROR_NOT_FOUND: the requested snap couldn't be found.
 * @SNAPD_ERROR_NOT_IN_STORE: the requested snap is not in the store.
 * @SNAPD_ERROR_AUTH_CANCELLED: authentication was cancelled by the user.
 * @SNAPD_ERROR_NOT_CLASSIC: snap not compatible with classic mode.
 * @SNAPD_ERROR_REVISION_NOT_AVAILABLE: requested snap revision not available.
 * @SNAPD_ERROR_CHANNEL_NOT_AVAILABLE: requested snap channel not available.
 * @SNAPD_ERROR_NOT_A_SNAP: the given snap or directory does not look like a snap.
 * @SNAPD_ERROR_DNS_FAILURE: A hostname failed to resolve during the request.
 * @SNAPD_ERROR_OPTION_NOT_FOUND: A requested configuration option is not set.
 * @SNAPD_ERROR_UNSUCCESSFUL: A snapctl command was unsuccessful.
 *
 * Error codes returned by snapd operations.
 *
 * Since: 1.0
 */
typedef enum
{
    SNAPD_ERROR_CONNECTION_FAILED,
    SNAPD_ERROR_WRITE_FAILED,
    SNAPD_ERROR_READ_FAILED,
    SNAPD_ERROR_BAD_REQUEST,
    SNAPD_ERROR_BAD_RESPONSE,
    SNAPD_ERROR_AUTH_DATA_REQUIRED,
    SNAPD_ERROR_AUTH_DATA_INVALID,
    SNAPD_ERROR_TWO_FACTOR_REQUIRED,
    SNAPD_ERROR_TWO_FACTOR_INVALID,
    SNAPD_ERROR_PERMISSION_DENIED,
    SNAPD_ERROR_FAILED,
    SNAPD_ERROR_TERMS_NOT_ACCEPTED,
    SNAPD_ERROR_PAYMENT_NOT_SETUP,
    SNAPD_ERROR_PAYMENT_DECLINED,
    SNAPD_ERROR_ALREADY_INSTALLED,
    SNAPD_ERROR_NOT_INSTALLED,
    SNAPD_ERROR_NO_UPDATE_AVAILABLE,
    SNAPD_ERROR_PASSWORD_POLICY_ERROR,
    SNAPD_ERROR_NEEDS_DEVMODE,
    SNAPD_ERROR_NEEDS_CLASSIC,
    SNAPD_ERROR_NEEDS_CLASSIC_SYSTEM,
    SNAPD_ERROR_BAD_QUERY,
    SNAPD_ERROR_NETWORK_TIMEOUT,
    SNAPD_ERROR_NOT_FOUND,
    SNAPD_ERROR_NOT_IN_STORE,
    SNAPD_ERROR_AUTH_CANCELLED,
    SNAPD_ERROR_NOT_CLASSIC,
    SNAPD_ERROR_REVISION_NOT_AVAILABLE,
    SNAPD_ERROR_CHANNEL_NOT_AVAILABLE,
    SNAPD_ERROR_NOT_A_SNAP,
    SNAPD_ERROR_DNS_FAILURE,
    SNAPD_ERROR_OPTION_NOT_FOUND,
    SNAPD_ERROR_UNSUCCESSFUL,
} SnapdError;

/**
 * SNAPD_ERROR:
 *
 * Error domain for errors returned by snapd. Errors in this domain will
 * be from the #SnapdError enumeration. See #GError for information
 * on error domains.
 */
#define SNAPD_ERROR snapd_error_quark ()

GQuark                  snapd_error_quark                          (void) G_GNUC_CONST;

G_END_DECLS

#endif /* __SNAPD_ERROR_H__ */
