using System;

namespace axXez.TS3.Protocol
{
    /// <summary>Represents an API key entry returned by <c>apikeyadd</c> or <c>apikeylist</c>.</summary>
    public class ApiKeyInfo : TsEntity
    {
        /// <summary>Numeric API key ID.</summary>
        [TsField("id")]
        public int ID { get; protected set; }

        /// <summary>Virtual server ID this key is bound to.</summary>
        [TsField("sid")]
        public int ServerID { get; protected set; }

        /// <summary>Database ID of the client who owns this key.</summary>
        [TsField("cldbid")]
        public int ClientDBID { get; protected set; }

        /// <summary>Access scope of this key: <c>"manage"</c>, <c>"write"</c>, or <c>"read"</c>.</summary>
        [TsField("scope")]
        public string Scope { get; protected set; }

        /// <summary>Remaining lifetime of this key in seconds.</summary>
        [TsField("time_left")]
        public int TimeLeft { get; protected set; }

        /// <summary>Date and time when this key was created.</summary>
        [TsField("created_at")]
        public DateTime CreatedAt { get; protected set; }

        /// <summary>Date and time when this key expires.</summary>
        [TsField("expires_at")]
        public DateTime ExpiresAt { get; protected set; }

        /// <summary>The API key token string. Only set when the key is first created; <c>null</c> when listed.</summary>
        [TsField("apikey")]
        public string ApiKey { get; protected set; }

        internal ApiKeyInfo(TsDataEntry data) : base(data) { }
    }
}