/* Options:
Date: 2025-05-04 22:38:40
Version: 8.71
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://team.evovoice.io

//GlobalNamespace: 
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//InitializeCollections: False
//ExportValueTypes: False
IncludeTypes: SyncPhoneNumbers.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Endpoints;

namespace Voice.Api.Endpoints
{
    public partial class EndpointInfo
        : EntityInfo
    {
        ///<summary>
        ///The account ID this endpoint is associated with
        ///</summary>
        [ApiMember(Description="The account ID this endpoint is associated with")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The name of the account this endpoint is associated with
        ///</summary>
        [ApiMember(Description="The name of the account this endpoint is associated with")]
        public virtual string AccountName { get; set; }

        ///<summary>
        ///The ID of the customer this endpoint is associated with
        ///</summary>
        [ApiMember(Description="The ID of the customer this endpoint is associated with")]
        public virtual string CustomerId { get; set; }

        ///<summary>
        ///The name of the customer this endpoint is associated with
        ///</summary>
        [ApiMember(Description="The name of the customer this endpoint is associated with")]
        public virtual string CustomerName { get; set; }

        ///<summary>
        ///The third party reference ID for the endpoint
        ///</summary>
        [ApiMember(Description="The third party reference ID for the endpoint")]
        public virtual string ReferenceId { get; set; }

        ///<summary>
        ///The breadcrumb to the customer for this endpoint
        ///</summary>
        [ApiMember(Description="The breadcrumb to the customer for this endpoint")]
        public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }

        ///<summary>
        ///The display name of the endpoint
        ///</summary>
        [ApiMember(Description="The display name of the endpoint")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The type of endpoint
        ///</summary>
        [ApiMember(Description="The type of endpoint")]
        public virtual EndpointTypes Type { get; set; }

        ///<summary>
        ///Extra info for this endpoint (typically to show in grid)
        ///</summary>
        [ApiMember(Description="Extra info for this endpoint (typically to show in grid)")]
        public virtual string ExtraInformation { get; set; }

        ///<summary>
        ///The ID of the flow to use for voice
        ///</summary>
        [ApiMember(Description="The ID of the flow to use for voice")]
        public virtual string FlowId { get; set; }

        ///<summary>
        ///The name of the flow to use for voice
        ///</summary>
        [ApiMember(Description="The name of the flow to use for voice")]
        public virtual string FlowName { get; set; }

        ///<summary>
        ///The params for the voice flow
        ///</summary>
        [ApiMember(Description="The params for the voice flow")]
        public virtual Struct FlowParams { get; set; }

        ///<summary>
        ///Whether to use a single flow always or use scheduled flow system
        ///</summary>
        [ApiMember(Description="Whether to use a single flow always or use scheduled flow system")]
        public virtual EndpointFlowSchedules FlowSchedule { get; set; }

        ///<summary>
        ///This endpoint's schedule
        ///</summary>
        [ApiMember(Description="This endpoint's schedule")]
        public virtual Schedule Schedule { get; set; }

        ///<summary>
        ///The list of scheduled flows when using scheduling
        ///</summary>
        [ApiMember(Description="The list of scheduled flows when using scheduling")]
        public virtual List<ScheduledFlow> ScheduledFlows { get; set; }

        ///<summary>
        ///Disable SMS
        ///</summary>
        [ApiMember(Description="Disable SMS")]
        public virtual bool DisableSms { get; set; }

        ///<summary>
        ///Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
        ///</summary>
        [ApiMember(Description="Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number")]
        public virtual bool UseExternal10DlcCampaign { get; set; }

        ///<summary>
        ///Is this a virtual phone number?
        ///</summary>
        [ApiMember(Description="Is this a virtual phone number?")]
        public virtual bool IsVirtualPhoneNumber { get; set; }

        ///<summary>
        ///Is caller ID verified for this virtual number?
        ///</summary>
        [ApiMember(Description="Is caller ID verified for this virtual number?")]
        public virtual bool IsCallerIdVerified { get; set; }

        ///<summary>
        ///The verification code for this number
        ///</summary>
        [ApiMember(Description="The verification code for this number")]
        public virtual string CallerIdVerificationCode { get; set; }

        ///<summary>
        ///The phone number
        ///</summary>
        [ApiMember(Description="The phone number")]
        public virtual string PhoneNumber { get; set; }

        ///<summary>
        ///The Sid of the phone number
        ///</summary>
        [ApiMember(Description="The Sid of the phone number")]
        public virtual string PhoneNumberSid { get; set; }

        ///<summary>
        ///The caller ID Name (CNAM) for the phone number
        ///</summary>
        [ApiMember(Description="The caller ID Name (CNAM) for the phone number")]
        public virtual string CallerIdName { get; set; }

        ///<summary>
        ///The address SID associated with the phone number
        ///</summary>
        [ApiMember(Description="The address SID associated with the phone number")]
        public virtual string AddressSid { get; set; }

        ///<summary>
        ///Do not touch this phone number - for BYOA accounts
        ///</summary>
        [ApiMember(Description="Do not touch this phone number - for BYOA accounts")]
        public virtual bool DoNotTouchPhoneNumber { get; set; }

        ///<summary>
        ///Is this number enrolled in a 10DLC messaging service campaign
        ///</summary>
        [ApiMember(Description="Is this number enrolled in a 10DLC messaging service campaign")]
        public virtual bool IsEnrolledIn10DlcService { get; set; }

        ///<summary>
        ///Whether we look up caller ID or not
        ///</summary>
        [ApiMember(Description="Whether we look up caller ID or not")]
        public virtual bool EnableCallerIdLookup { get; set; }

        ///<summary>
        ///The email address of the user
        ///</summary>
        [ApiMember(Description="The email address of the user")]
        public virtual string UserEmailAddress { get; set; }

        ///<summary>
        ///The Twilio Region for the SIP endpoint
        ///</summary>
        [ApiMember(Description="The Twilio Region for the SIP endpoint")]
        public virtual TwilioSipRegions SipRegion { get; set; }

        ///<summary>
        ///The Twilio Sid of the credentials for Sip
        ///</summary>
        [ApiMember(Description="The Twilio Sid of the credentials for Sip")]
        public virtual string SipCredentialSid { get; set; }

        ///<summary>
        ///The Twilio SIP user name
        ///</summary>
        [ApiMember(Description="The Twilio SIP user name")]
        public virtual string SipUserName { get; set; }

        ///<summary>
        ///The Twilio SIP password
        ///</summary>
        [ApiMember(Description="The Twilio SIP password")]
        public virtual string SipPassword { get; set; }

        ///<summary>
        ///The SIP domain
        ///</summary>
        [ApiMember(Description="The SIP domain")]
        public virtual string SipDomain { get; set; }

        ///<summary>
        ///Is emergency calling enabled on this number?
        ///</summary>
        [ApiMember(Description="Is emergency calling enabled on this number?")]
        public virtual bool EnableEmergencyCalling { get; set; }

        ///<summary>
        ///The SID of the emergency address for this number
        ///</summary>
        [ApiMember(Description="The SID of the emergency address for this number")]
        public virtual string EmergencyAddressSid { get; set; }

        ///<summary>
        ///The ID of the phone number to use for emergency dialing
        ///</summary>
        [ApiMember(Description="The ID of the phone number to use for emergency dialing")]
        public virtual string EmergencyPhoneNumberId { get; set; }

        ///<summary>
        ///The current agent state of this user endpoint
        ///</summary>
        [ApiMember(Description="The current agent state of this user endpoint")]
        public virtual AgentStates AgentState { get; set; }

        ///<summary>
        ///The current agent state reason of this user endpoint
        ///</summary>
        [ApiMember(Description="The current agent state reason of this user endpoint")]
        public virtual AgentStateReasons AgentStateReason { get; set; }

        ///<summary>
        ///The mode for this user
        ///</summary>
        [ApiMember(Description="The mode for this user")]
        public virtual UserModes UserMode { get; set; }

        ///<summary>
        ///The ID of the file to use for voicemail greeting
        ///</summary>
        [ApiMember(Description="The ID of the file to use for voicemail greeting")]
        public virtual string VoicemailGreetingId { get; set; }

        ///<summary>
        ///The endpoint's data
        ///</summary>
        [ApiMember(Description="The endpoint's data")]
        public virtual Struct Data { get; set; }

        ///<summary>
        ///The email address for email endpoints
        ///</summary>
        [ApiMember(Description="The email address for email endpoints")]
        public virtual string EmailAddress { get; set; }

        ///<summary>
        ///The first name of the user (for user endpoints)
        ///</summary>
        [ApiMember(Description="The first name of the user (for user endpoints)")]
        public virtual string UserFirstName { get; set; }

        ///<summary>
        ///The last name of the user (for user endpoints)
        ///</summary>
        [ApiMember(Description="The last name of the user (for user endpoints)")]
        public virtual string UserLastName { get; set; }

        ///<summary>
        ///The URL of an image for this user's avatar
        ///</summary>
        [ApiMember(Description="The URL of an image for this user's avatar")]
        public virtual string AvatarUrl { get; set; }

        ///<summary>
        ///Does this user have manager role?
        ///</summary>
        [ApiMember(Description="Does this user have manager role?")]
        public virtual UserManagerRoles ManagerRole { get; set; }

        ///<summary>
        ///The list of dashboard permissions for when the manager role is custom
        ///</summary>
        [ApiMember(Description="The list of dashboard permissions for when the manager role is custom")]
        public virtual List<DashboardPermissions> DashboardPermissions { get; set; }

        ///<summary>
        ///The type of visibility this user has to their own fields
        ///</summary>
        [ApiMember(Description="The type of visibility this user has to their own fields")]
        public virtual UserDataFieldModes MyFieldPermissions { get; set; }

        ///<summary>
        ///The type of visibility this user has to customer fields
        ///</summary>
        [ApiMember(Description="The type of visibility this user has to customer fields")]
        public virtual UserDataFieldModes CustomerFieldPermissions { get; set; }

        ///<summary>
        ///The type of visibility this user has to other user fields
        ///</summary>
        [ApiMember(Description="The type of visibility this user has to other user fields")]
        public virtual UserDataFieldModes OtherUserFieldPermissions { get; set; }

        ///<summary>
        ///The type of visibility this user has to other endpoint fields
        ///</summary>
        [ApiMember(Description="The type of visibility this user has to other endpoint fields")]
        public virtual UserDataFieldModes OtherEndpointFieldPermissions { get; set; }

        ///<summary>
        ///The name of this endpoint (for bots etc.)
        ///</summary>
        [ApiMember(Description="The name of this endpoint (for bots etc.)")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The list of tags for this endpoint
        ///</summary>
        [ApiMember(Description="The list of tags for this endpoint")]
        public virtual List<Tag> Tags { get; set; }

        ///<summary>
        ///The list of action URLs
        ///</summary>
        [ApiMember(Description="The list of action URLs")]
        public virtual List<EndpointActionUrl> ActionUrls { get; set; }

        ///<summary>
        ///The list of members in this team
        ///</summary>
        [ApiMember(Description="The list of members in this team")]
        public virtual List<string> TeamMemberIds { get; set; }

        ///<summary>
        ///Visibility of this user/team in contact lists
        ///</summary>
        [ApiMember(Description="Visibility of this user/team in contact lists")]
        public virtual CustomerVisibility ContactListVisibility { get; set; }

        ///<summary>
        ///The list of contacts personal to this user
        ///</summary>
        [ApiMember(Description="The list of contacts personal to this user")]
        public virtual List<EndpointContact> Contacts { get; set; }

        ///<summary>
        ///The documo ID for this number
        ///</summary>
        [ApiMember(Description="The documo ID for this number")]
        public virtual string DocumoId { get; set; }

        ///<summary>
        ///Integration data for this endpoint
        ///</summary>
        [ApiMember(Description="Integration data for this endpoint")]
        public virtual EntityIntegrationData IntegrationData { get; set; }

        ///<summary>
        ///Settings for third party phone system
        ///</summary>
        [ApiMember(Description="Settings for third party phone system")]
        public virtual ThirdPartyPhoneSystemSettings ThirdPartyPhoneSystemSettings { get; set; }

        ///<summary>
        ///Should this user override the parent customer's app settings
        ///</summary>
        [ApiMember(Description="Should this user override the parent customer's app settings")]
        public virtual bool OverrideAppSettings { get; set; }

        ///<summary>
        ///App / Portal settings for this user
        ///</summary>
        [ApiMember(Description="App / Portal settings for this user")]
        public virtual AppSettings AppSettings { get; set; }

        ///<summary>
        ///Configuration for the AI assistant
        ///</summary>
        [ApiMember(Description="Configuration for the AI assistant")]
        public virtual AssistantSettings AssistantSettings { get; set; }

        ///<summary>
        ///Configuration for the embed
        ///</summary>
        [ApiMember(Description="Configuration for the embed")]
        public virtual EmbedSettings EmbedSettings { get; set; }
    }

    ///<summary>
    ///Syncs list of phone numbers with Twilio detecting any newly ported numbers, status changes, etc.
    ///</summary>
    [Route("/phone-numbers/sync", "POST")]
    [Api(Description="Syncs list of phone numbers with Twilio detecting any newly ported numbers, status changes, etc.")]
    public partial class SyncPhoneNumbers
        : IReturn<SyncPhoneNumbersResponse>, IPost
    {
        ///<summary>
        ///The account ID you want to sync
        ///</summary>
        [ApiMember(Description="The account ID you want to sync")]
        public virtual string AccountId { get; set; }
    }

    public partial class SyncPhoneNumbersResponse
    {
        public virtual List<EndpointInfo> NewPhoneNumbers { get; set; }
        public virtual List<EndpointInfo> UpdatedPhoneNumbers { get; set; }
    }

}