using System;
using Microsoft.AspNetCore.Http;
using xIdentityModels.Navigations;

namespace xIdentityModels.Models {
    /// <summary>
    /// represent a system wide actions
    /// </summary>
    public class XActionRequest {
        /// <summary>
        /// Client Device Locale
        /// </summary>
        /// <value>user's client device local such as en-US</value>
        public string Lang { get; set; } = null;
        /// <summary>
        /// Requested Action Token
        /// </summary>
        /// <value>a hashed content</value>
        public string ActionToken { get; set; } = null;
        /// <summary>
        /// user's device
        /// </summary>
        /// <value>an instance of <see>XDevice</see> which represent user's device</value>
        public XDevice Device { get; set; } = null;
        /// <summary>
        /// FirstName 
        /// </summary>
        /// <value>users FirstName</value>
        public string FirstName { get; set; } = null;
        /// <summary>
        /// LastName 
        /// </summary>
        /// <value>user's LastName</value>
        public string LastName { get; set; } = null;
        /// <summary>
        /// an Optional Value which represetns User's DateOfBirth
        /// </summary>
        /// <value>user's DateOfBirth</value>
        public DateTime? DateOfBirth { get; set; } = DateTime.MinValue;
        /// <summary>
        /// User's Id
        /// </summary>
        /// <value>a GUID string which represent user's Id</value>
        public string UserId { get; set; } = null;
        /// <summary>
        /// UserName
        /// </summary>
        /// <value>user's UserName</value>
        public string UserName { get; set; } = null;
        /// <summary>
        /// Email
        /// </summary>
        /// <value>user's Email address</value>
        public string Email { get; set; } = null;
        /// <summary>
        /// MobileNumber / PhoneNumber
        /// </summary>
        /// <value>user's PhoneNumber</value>
        public string MobileNumber { get; set; } = null;
        /// <summary>
        /// Password
        /// </summary>
        /// <value>user's Password</value>
        public string Password { get; set; } = null;
        /// <summary>
        /// NewPassword
        /// </summary>
        /// <value>a passwor string which used to Change/Reset password</value>
        public string NewPassword { get; set; } = null;
        /// <summary>
        /// EmailVerificationCode
        /// </summary>
        /// <value>a Verification Code which assign to user's for confirm it's Email Address</value>
        public string EmailVerificationCode { get; set; } = null;
        /// <summary>
        /// MobileVerificationCode
        /// </summary>
        /// <value>a Verification Code which assign to user's for confirm it's Phone Number</value>
        public string MobileVerificationCode { get; set; } = null;
        /// <summary>
        /// Thumbnail
        /// </summary>
        /// <value>an instance of <see>IFormFile</see> which is used as user's avatar</value>
        public IFormFile Thumbnail { get; set; }
        /// <summary>
        /// ReturnUrl
        /// </summary>
        /// <value>
        /// a url string which used in many used cases for providing a way to lead users to right places.
        /// </value>
        public string ReturnUrl { get; set; } = null;
    }
}