/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

/*
 * Do not modify this file. This file is generated from the pinpoint-2016-12-01.normal.json service model.
 */
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;

using Amazon.Runtime;
using Amazon.Runtime.Internal;

namespace Amazon.Pinpoint.Model
{
    /// <summary>
    /// Provides information about the status, configuration, and other settings for a journey.
    /// </summary>
    public partial class JourneyResponse
    {
        private Dictionary<string, Activity> _activities = new Dictionary<string, Activity>();
        private string _applicationId;
        private ClosedDays _closedDays;
        private string _creationDate;
        private string _id;
        private JourneyChannelSettings _journeyChannelSettings;
        private string _lastModifiedDate;
        private JourneyLimits _limits;
        private bool? _localTime;
        private string _name;
        private OpenHours _openHours;
        private QuietTime _quietTime;
        private string _refreshFrequency;
        private bool? _refreshOnSegmentUpdate;
        private JourneySchedule _schedule;
        private bool? _sendingSchedule;
        private string _startActivity;
        private StartCondition _startCondition;
        private State _state;
        private Dictionary<string, string> _tags = new Dictionary<string, string>();
        private List<string> _timezoneEstimationMethods = new List<string>();
        private bool? _waitForQuietTime;

        /// <summary>
        /// Gets and sets the property Activities. 
        /// <para>
        /// A map that contains a set of Activity objects, one object for each activity in the
        /// journey. For each Activity object, the key is the unique identifier (string) for an
        /// activity and the value is the settings for the activity.
        /// </para>
        /// </summary>
        public Dictionary<string, Activity> Activities
        {
            get { return this._activities; }
            set { this._activities = value; }
        }

        // Check to see if Activities property is set
        internal bool IsSetActivities()
        {
            return this._activities != null && this._activities.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property ApplicationId. 
        /// <para>
        /// The unique identifier for the application that the journey applies to.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public string ApplicationId
        {
            get { return this._applicationId; }
            set { this._applicationId = value; }
        }

        // Check to see if ApplicationId property is set
        internal bool IsSetApplicationId()
        {
            return this._applicationId != null;
        }

        /// <summary>
        /// Gets and sets the property ClosedDays. 
        /// <para>
        /// The time when a journey will not send messages. QuietTime should be configured first
        /// and SendingSchedule should be set to true.
        /// </para>
        /// </summary>
        public ClosedDays ClosedDays
        {
            get { return this._closedDays; }
            set { this._closedDays = value; }
        }

        // Check to see if ClosedDays property is set
        internal bool IsSetClosedDays()
        {
            return this._closedDays != null;
        }

        /// <summary>
        /// Gets and sets the property CreationDate. 
        /// <para>
        /// The date, in ISO 8601 format, when the journey was created.
        /// </para>
        /// </summary>
        public string CreationDate
        {
            get { return this._creationDate; }
            set { this._creationDate = value; }
        }

        // Check to see if CreationDate property is set
        internal bool IsSetCreationDate()
        {
            return this._creationDate != null;
        }

        /// <summary>
        /// Gets and sets the property Id. 
        /// <para>
        /// The unique identifier for the journey.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public string Id
        {
            get { return this._id; }
            set { this._id = value; }
        }

        // Check to see if Id property is set
        internal bool IsSetId()
        {
            return this._id != null;
        }

        /// <summary>
        /// Gets and sets the property JourneyChannelSettings. 
        /// <para>
        /// The channel-specific configurations for the journey.
        /// </para>
        /// </summary>
        public JourneyChannelSettings JourneyChannelSettings
        {
            get { return this._journeyChannelSettings; }
            set { this._journeyChannelSettings = value; }
        }

        // Check to see if JourneyChannelSettings property is set
        internal bool IsSetJourneyChannelSettings()
        {
            return this._journeyChannelSettings != null;
        }

        /// <summary>
        /// Gets and sets the property LastModifiedDate. 
        /// <para>
        /// The date, in ISO 8601 format, when the journey was last modified.
        /// </para>
        /// </summary>
        public string LastModifiedDate
        {
            get { return this._lastModifiedDate; }
            set { this._lastModifiedDate = value; }
        }

        // Check to see if LastModifiedDate property is set
        internal bool IsSetLastModifiedDate()
        {
            return this._lastModifiedDate != null;
        }

        /// <summary>
        /// Gets and sets the property Limits. 
        /// <para>
        /// The messaging and entry limits for the journey.
        /// </para>
        /// </summary>
        public JourneyLimits Limits
        {
            get { return this._limits; }
            set { this._limits = value; }
        }

        // Check to see if Limits property is set
        internal bool IsSetLimits()
        {
            return this._limits != null;
        }

        /// <summary>
        /// Gets and sets the property LocalTime. 
        /// <para>
        /// Specifies whether the journey's scheduled start and end times use each participant's
        /// local time. If this value is true, the schedule uses each participant's local time.
        /// </para>
        /// </summary>
        public bool LocalTime
        {
            get { return this._localTime.GetValueOrDefault(); }
            set { this._localTime = value; }
        }

        // Check to see if LocalTime property is set
        internal bool IsSetLocalTime()
        {
            return this._localTime.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Name. 
        /// <para>
        /// The name of the journey.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public string Name
        {
            get { return this._name; }
            set { this._name = value; }
        }

        // Check to see if Name property is set
        internal bool IsSetName()
        {
            return this._name != null;
        }

        /// <summary>
        /// Gets and sets the property OpenHours. 
        /// <para>
        /// The time when a journey can send messages. QuietTime should be configured first and
        /// SendingSchedule should be set to true.
        /// </para>
        /// </summary>
        public OpenHours OpenHours
        {
            get { return this._openHours; }
            set { this._openHours = value; }
        }

        // Check to see if OpenHours property is set
        internal bool IsSetOpenHours()
        {
            return this._openHours != null;
        }

        /// <summary>
        /// Gets and sets the property QuietTime. 
        /// <para>
        /// The quiet time settings for the journey. Quiet time is a specific time range when
        /// a journey doesn't send messages to participants, if all the following conditions are
        /// met:
        /// </para>
        ///  <ul><li>
        /// <para>
        /// The EndpointDemographic.Timezone property of the endpoint for the participant is set
        /// to a valid value.
        /// </para>
        /// </li> <li>
        /// <para>
        /// The current time in the participant's time zone is later than or equal to the time
        /// specified by the QuietTime.Start property for the journey.
        /// </para>
        /// </li> <li>
        /// <para>
        /// The current time in the participant's time zone is earlier than or equal to the time
        /// specified by the QuietTime.End property for the journey.
        /// </para>
        /// </li></ul> 
        /// <para>
        /// If any of the preceding conditions isn't met, the participant will receive messages
        /// from the journey, even if quiet time is enabled.
        /// </para>
        /// </summary>
        public QuietTime QuietTime
        {
            get { return this._quietTime; }
            set { this._quietTime = value; }
        }

        // Check to see if QuietTime property is set
        internal bool IsSetQuietTime()
        {
            return this._quietTime != null;
        }

        /// <summary>
        /// Gets and sets the property RefreshFrequency. 
        /// <para>
        /// The frequency with which Amazon Pinpoint evaluates segment and event data for the
        /// journey, as a duration in ISO 8601 format.
        /// </para>
        /// </summary>
        public string RefreshFrequency
        {
            get { return this._refreshFrequency; }
            set { this._refreshFrequency = value; }
        }

        // Check to see if RefreshFrequency property is set
        internal bool IsSetRefreshFrequency()
        {
            return this._refreshFrequency != null;
        }

        /// <summary>
        /// Gets and sets the property RefreshOnSegmentUpdate. 
        /// <para>
        /// Indicates whether the journey participants should be refreshed when a segment is updated.
        /// </para>
        /// </summary>
        public bool RefreshOnSegmentUpdate
        {
            get { return this._refreshOnSegmentUpdate.GetValueOrDefault(); }
            set { this._refreshOnSegmentUpdate = value; }
        }

        // Check to see if RefreshOnSegmentUpdate property is set
        internal bool IsSetRefreshOnSegmentUpdate()
        {
            return this._refreshOnSegmentUpdate.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Schedule. 
        /// <para>
        /// The schedule settings for the journey.
        /// </para>
        /// </summary>
        public JourneySchedule Schedule
        {
            get { return this._schedule; }
            set { this._schedule = value; }
        }

        // Check to see if Schedule property is set
        internal bool IsSetSchedule()
        {
            return this._schedule != null;
        }

        /// <summary>
        /// Gets and sets the property SendingSchedule. 
        /// <para>
        /// Indicates if journey has Advance Quiet Time enabled. This flag should be set to true
        /// in order to allow using OpenHours and ClosedDays.
        /// </para>
        /// </summary>
        public bool SendingSchedule
        {
            get { return this._sendingSchedule.GetValueOrDefault(); }
            set { this._sendingSchedule = value; }
        }

        // Check to see if SendingSchedule property is set
        internal bool IsSetSendingSchedule()
        {
            return this._sendingSchedule.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property StartActivity. 
        /// <para>
        /// The unique identifier for the first activity in the journey.
        /// </para>
        /// </summary>
        public string StartActivity
        {
            get { return this._startActivity; }
            set { this._startActivity = value; }
        }

        // Check to see if StartActivity property is set
        internal bool IsSetStartActivity()
        {
            return this._startActivity != null;
        }

        /// <summary>
        /// Gets and sets the property StartCondition. 
        /// <para>
        /// The segment that defines which users are participants in the journey.
        /// </para>
        /// </summary>
        public StartCondition StartCondition
        {
            get { return this._startCondition; }
            set { this._startCondition = value; }
        }

        // Check to see if StartCondition property is set
        internal bool IsSetStartCondition()
        {
            return this._startCondition != null;
        }

        /// <summary>
        /// Gets and sets the property State. 
        /// <para>
        /// The current status of the journey. Possible values are:
        /// </para>
        ///  <ul><li>
        /// <para>
        /// DRAFT - The journey is being developed and hasn't been published yet.
        /// </para>
        /// </li> <li>
        /// <para>
        /// ACTIVE - The journey has been developed and published. Depending on the journey's
        /// schedule, the journey may currently be running or scheduled to start running at a
        /// later time. If a journey's status is ACTIVE, you can't add, change, or remove activities
        /// from it.
        /// </para>
        /// </li> <li>
        /// <para>
        /// COMPLETED - The journey has been published and has finished running. All participants
        /// have entered the journey and no participants are waiting to complete the journey or
        /// any activities in the journey.
        /// </para>
        /// </li> <li>
        /// <para>
        /// CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you
        /// can't add, change, or remove activities or segment settings from the journey.
        /// </para>
        /// </li> <li>
        /// <para>
        /// CLOSED - The journey has been published and has started running. It may have also
        /// passed its scheduled end time, or passed its scheduled start time and a refresh frequency
        /// hasn't been specified for it. If a journey's status is CLOSED, you can't add participants
        /// to it, and no existing participants can enter the journey for the first time. However,
        /// any existing participants who are currently waiting to start an activity may continue
        /// the journey.
        /// </para>
        /// </li></ul>
        /// </summary>
        public State State
        {
            get { return this._state; }
            set { this._state = value; }
        }

        // Check to see if State property is set
        internal bool IsSetState()
        {
            return this._state != null;
        }

        /// <summary>
        /// Gets and sets the property Tags. 
        /// <para>
        /// This object is not used or supported.
        /// </para>
        /// </summary>
        public Dictionary<string, string> Tags
        {
            get { return this._tags; }
            set { this._tags = value; }
        }

        // Check to see if Tags property is set
        internal bool IsSetTags()
        {
            return this._tags != null && this._tags.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property TimezoneEstimationMethods. 
        /// <para>
        /// An array of time zone estimation methods, if any, to use for determining an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html">Endpoints</a>
        /// time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
        /// </para>
        ///  <ul> <li>
        /// <para>
        /// PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
        /// </para>
        /// </li> <li>
        /// <para>
        /// POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode
        /// and Endpoint.Location.Country.
        /// </para>
        ///  <note>
        /// <para>
        /// POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia,
        /// New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint
        /// is available.
        /// </para>
        /// </note></li> </ul>
        /// </summary>
        public List<string> TimezoneEstimationMethods
        {
            get { return this._timezoneEstimationMethods; }
            set { this._timezoneEstimationMethods = value; }
        }

        // Check to see if TimezoneEstimationMethods property is set
        internal bool IsSetTimezoneEstimationMethods()
        {
            return this._timezoneEstimationMethods != null && this._timezoneEstimationMethods.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property WaitForQuietTime. 
        /// <para>
        /// Indicates whether endpoints in quiet hours should enter a wait activity until quiet
        /// hours have elapsed.
        /// </para>
        /// </summary>
        public bool WaitForQuietTime
        {
            get { return this._waitForQuietTime.GetValueOrDefault(); }
            set { this._waitForQuietTime = value; }
        }

        // Check to see if WaitForQuietTime property is set
        internal bool IsSetWaitForQuietTime()
        {
            return this._waitForQuietTime.HasValue; 
        }

    }
}