using System;
using System.ComponentModel;
using System.Runtime.Serialization;

namespace TS.Insightly.API.Contract
{
    /// <summary>
    /// Insightly contact info record.
    /// These records hold details like email addresses for a contact.
    /// </summary>
    [Serializable]
    [DataContract]
    public class ContactInfo
    {
        #region Enumerations.

        /// <summary>
        /// Values for the TYPE field, use the enum description.
        /// <see cref="ContactInfo.TYPE"/>
        /// </summary>
        public enum InfoType
        {
            /// <summary>
            /// Phone information type.
            /// </summary>
            [Description("PHONE")]
            Phone,

            /// <summary>
            /// Email information type.
            /// </summary>
            [Description("EMAIL")]
            Email,

            /// <summary>
            /// Social information type.
            /// </summary>
            [Description("SOCIAL")]
            Social,

            /// <summary>
            /// Website information type.
            /// </summary>
            [Description("WEBSITE")]
            Website,

            /// <summary>
            /// EmailDomain information type, this type is 
            /// only valid for Organisation contact info.
            /// <seealso cref="Organisation"/>
            /// </summary>
            [Description("EMAILDOMAIN")]
            EmailDomain
        }

        /// <summary>
        /// Values for the LABEL field when type is EMAIL, use the enum description.
        /// <see cref="ContactInfo.LABEL"/>
        /// </summary>
        public enum InfoLabelEmail
        {
            /// <summary>
            /// Work label for Email.
            /// </summary>
            [Description("Work")]
            Work,

            /// <summary>
            /// Personal label for Email.
            /// </summary>
            [Description("Personal")]
            Personal,

            /// <summary>
            /// Other label for Email.
            /// </summary>
            [Description("Other")]
            Other
        }

        /// <summary>
        /// Values for the LABEL field when type is PHONE, use the enum description.
        /// <see cref="ContactInfo.LABEL" />
        /// </summary>
        public enum InfoLabelPhone
        {
            /// <summary>
            /// Work label for phone.
            /// </summary>
            [Description("Work")]
            Work,

            /// <summary>
            /// Mobile label for phone.
            /// </summary>
            [Description("Mobile")]
            Mobile,

            /// <summary>
            /// Fax label for phone.
            /// </summary>
            [Description("Fax")]
            Fax,

            /// <summary>
            /// Pager label for phone.
            /// </summary>
            [Description("Pager")]
            Pager,

            /// <summary>
            /// Home label for phone.
            /// </summary>
            [Description("Home")]
            Home,

            /// <summary>
            /// Skype label for phone.
            /// </summary>
            [Description("Skype")]
            Skype,

            /// <summary>
            /// Y! Messenger label for phone.
            /// </summary>
            [Description("Y! Messenger")]
            YMessenger,

            /// <summary>
            /// SIP label for phone.
            /// </summary>
            [Description("SIP")]
            SIP,

            /// <summary>
            /// Other label for phone.
            /// </summary>
            [Description("Other")]
            Other
        }

        /// <summary>
        /// Values for the LABEL field when type is WEBSITE, use the enum description.
        /// <see cref="ContactInfo.LABEL" />
        /// </summary>
        public enum InfoLabelWebsite
        {
            /// <summary>
            /// Work label for website.
            /// </summary>
            [Description("Work")]
            Work,

            /// <summary>
            /// Personal label for website.
            /// </summary>
            [Description("Personal")]
            Personal,

            /// <summary>
            /// Blog label for website.
            /// </summary>
            [Description("Blog")]
            Blog,

            /// <summary>
            /// Other label for website.
            /// </summary>
            [Description("Other")]
            Other
        }

        /// <summary>
        /// Values for the LABEL field when type is SOCIAL, use the enum description.
        /// <see cref="ContactInfo.LABEL"/>
        /// </summary>
        public enum InfoLabelSocial
        {
            /// <summary>
            /// The linkedIn public profile URL
            /// </summary>
            [Description("LinkedInPublicProfileUrl")]
            LinkedInPublicProfileUrl,

            /// <summary>
            /// The twitter ID.
            /// </summary>
            [Description("TwitterID")]
            TwitterID
        }

        #endregion Enumerations.

        /// <summary>
        /// Gets or sets the contact information unique identifier.
        /// </summary>
        /// <value>
        /// The contact information unique identifier.
        /// </value>
        public int CONTACT_INFO_ID { get; set; }

        /// <summary>
        /// Gets or sets the type of contact info, for example "EMAIL".
        /// See InfoType enumeration.
        /// <b>Is Required.</b>
        /// </summary>
        /// <value>
        /// The information type.
        /// </value>
        /// <seealso cref="InfoType"/>
        [DataMember]
        public string TYPE { get; set; }

        /// <summary>
        /// Gets or sets the subtype.
        /// </summary>
        /// <value>
        /// The subtype.
        /// </value>
        [DataMember]
        public string SUBTYPE { get; set; }

        /// <summary>
        /// Gets or sets the label for the info, for example for an email this could be "Work".
        /// See the various InfoLabel enumerations.
        /// </summary>
        /// <value>
        /// The label.
        /// </value>
        /// <seealso cref="InfoLabelWebsite"/>
        /// <seealso cref="InfoLabelPhone"/>
        /// <seealso cref="InfoLabelEmail"/>
        /// <seealso cref="InfoLabelSocial"/>
        [DataMember]
        public string LABEL { get; set; }

        /// <summary>
        /// Gets or sets the detail.
        /// For an email type info record this will be the actual email address.
        /// <b>Is Required.</b>
        /// </summary>
        /// <value>
        /// The detail.
        /// </value>
        [DataMember]
        public string DETAIL { get; set; }
    }
}