using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Runtime.Serialization;

namespace TS.Insightly.API.Contract
{
    /// <summary>
    /// Insightly organisation record.
    /// </summary>
    [Serializable]
    [DataContract]
    public class Organisation
    {
        /// <summary>
        /// Values for the VISIBLE_TO field, use the enum description.
        /// <see cref="Contact.VISIBLE_TO"/>
        /// </summary>
        public enum VisibleToOption
        {
            /// <summary>
            /// Visible to Everyone.
            /// </summary>
            [Description("Everyone")]
            Everyone,

            /// <summary>
            /// Visible to Owner.
            /// </summary>
            [Description("Owner")]
            Owner,

            /// <summary>
            /// Visible to Team.
            /// </summary>
            [Description("Team")]
            Team,

            /// <summary>
            /// Visible to individuals.
            /// </summary>
            [Description("Individuals")]
            Individuals
        }

        /// <summary>
        /// Gets or sets the organisation unique identifier.
        /// Note this is the insightly organisation id, not the Id
        /// that is shown in the web browser for a organisation record.
        /// </summary>
        /// <value>
        /// The organisation unique identifier.
        /// </value>
        public int ORGANISATION_ID { get; set; }

        /// <summary>
        /// Gets or sets the name of the organisation.
        /// <b>Is Required.</b>
        /// </summary>
        /// <value>
        /// The name of the organisation.
        /// </value>
        [DataMember]
        public string ORGANISATION_NAME { get; set; }

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

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

        /// <summary>
        /// Gets or sets the id of the record owner.
        /// </summary>
        /// <value>
        /// The id of the record owner.
        /// </value>
        [DataMember]
        public int OWNER_USER_ID { get; set; }

        /// <summary>
        /// Gets or sets the date created (UTC).
        /// </summary>
        /// <value>
        /// The date created (UTC).
        /// </value>
        public DateTime DATE_CREATED_UTC { get; set; }

        /// <summary>
        /// Gets or sets the date updated (UTC).
        /// </summary>
        /// <value>
        /// The date updated (UTC).
        /// </value>
        public DateTime DATE_UPDATED_UTC { get; set; }

        /// <summary>
        /// Gets or sets visible to.
        /// See the VisibleToOption enumerations.
        /// </summary>
        /// <value>
        /// The visible to.
        /// </value>
        /// <seealso cref="Organisation.VisibleToOption"/>
        [DataMember]
        public string VISIBLE_TO { get; set; }

        /// <summary>
        /// Gets or sets the team id the contact is visible to.
        /// </summary>
        /// <value>
        /// The visible team id.
        /// </value>
        [DataMember]
        public int VISIBLE_TEAM_ID { get; set; }

        /// <summary>
        /// Gets or sets the user ids the contact is visible to.
        /// Comma separated list of User Ids if <see cref="VISIBLE_TO"/> is <see cref="Organisation.VisibleToOption.Individuals"/>.
        /// </summary>
        /// <value>
        /// The visible user ids.
        /// </value>
        [DataMember]
        public string VISIBLE_USER_IDS { get; set; }

        /// <summary>
        /// Gets or sets the list of contact information for the contact,
        /// this includes the list of email addresses.
        /// </summary>
        /// <value>
        /// The contact information.
        /// </value>
        [DataMember]
        public List<ContactInfo> CONTACTINFOS { get; set; }

        /// <summary>
        /// Gets or sets the addresses for the contact.
        /// </summary>
        /// <value>
        /// The addresses.
        /// </value>
        [DataMember]
        public List<Address> ADDRESSES { get; set; } 
    }
}