/*
 * Groovy UpCloud library - Resource Module
 * Copyright (C) 2018  Mikko VÃ¤rri
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package fi.linuxbox.upcloud.resource

import fi.linuxbox.upcloud.core.Resource
import groovy.transform.CompileStatic
import groovy.transform.InheritConstructors

/**
 * UpCloud API account information.
 * <p>
 *     An instance of this is typically fetched from {@link fi.linuxbox.upcloud.api.UpCloudApi#account(def) Account API}.
 * </p>
 */
@CompileStatic
@InheritConstructors
class Account extends Resource {
    /**
     * Number of credits still available on the UpCloud account.
     * <p>
     *     The credits correspond to the super-account of the UpCloud API account.
     *     The API users do not have their own credits.
     * </p>
     */
    BigDecimal credits
    /**
     * The UpCloud API username.
     * <p>
     *     This is typically the sub-account of the UpCloud account.
     * </p>
     */
    String username
    /**
     * Resource limits of an non-trial account.
     */
    ResourceLimits resourceLimits
    /**
     * Resource limits of an trial account.
     * <p>
     *     This is not available for non-trial accounts.
     * </p>
     */
    TrialResourceLimits trialResourceLimits
}
