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

namespace TS.Insightly.API.Contract
{
    /// <summary>
    /// Insightly address record.
    /// </summary>
    [Serializable]
    [DataContract]
    public class Address
    {
        #region Enumerations

        /// <summary>
        /// Values for the ADDRESS_TYPE field.
        /// </summary>
        /// <see cref="Address.ADDRESS_TYPE"/>
        public enum AddressType
        {
            /// <summary>
            /// Work address type.
            /// </summary>
            [Description("Work")]
            Work,

            /// <summary>
            /// Home address type.
            /// <b>Not valid for <see cref="Organisation"/></b>
            /// </summary>
            [Description("Home")]
            Home,

            /// <summary>
            /// Postal address type.
            /// </summary>
            [Description("Postal")]
            Postal,

            /// <summary>
            /// Other address type.
            /// </summary>
            [Description("Other")]
            Other
        }

        #endregion Enumerations

        /// <summary>
        /// Gets or sets the address identifier.
        /// </summary>
        /// <value>
        /// The address identifier.
        /// </value>
        public int ADDRESS_ID { get; set; }


        /// <summary>
        /// Gets or sets the type of the address_.
        /// </summary>
        /// <value>
        /// The type of the address_.
        /// </value>
        /// <see cref="AddressType"/>
        [DataMember]
        public string ADDRESS_TYPE { get; set; }

        /// <summary>
        /// Gets or sets the street number and name.
        /// </summary>
        /// <value>
        /// The street number and name.
        /// </value>
        [DataMember]
        public string STREET { get; set; }

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

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

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

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

    }
}