/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: Emails.Transactional.Client
* File: TransactionResult.cs 
*
* TransactionResult.cs is part of Emails.Transactional.Client which is part of the larger 
* VNLib collection of libraries and utilities.
*
* Emails.Transactional.Client 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 2 of the License,
* or (at your option) any later version.
*
* Emails.Transactional.Client 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 Emails.Transactional.Client. If not, see http://www.gnu.org/licenses/.
*/

using System;
using System.Collections.Generic;
using System.Text.Json.Serialization;

using VNLib.Plugins;

namespace Emails.Transactional.Client
{
    /// <summary>
    /// A JSON serializable object that contains the results of the transaction
    /// </summary>
    public class TransactionResult : WebMessage
    {
        /// <summary>
        /// The unique identifier for the transaction
        /// </summary>
        [JsonPropertyName("transaction_id")]
        public string TransactionId { get; set; } = string.Empty;

        /// <summary>
        /// The raw SMTP result if SMTP was used
        /// </summary>
        [JsonPropertyName("smtp_status")]
        public string? SmtpStatus { get; set; }       

        /// <summary>
        /// A system specific error code
        /// </summary>
        [JsonPropertyName("error_code")]
        public string? ErrorCode { get; set; }

        /// <summary>
        /// A string description of the error
        /// </summary>
        [JsonPropertyName("error_description")]
        public string? ErrorDescription { get; set; }

        /// <summary>
        /// A collection of server validation errors
        /// </summary>
        [JsonPropertyName("errors")]
        public ICollection<ValidationErrorMessage> ValidationErrors { get; set; } = Array.Empty<ValidationErrorMessage>();
    }
}