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

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: SyncPhoneNumbers.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Syncs list of phone numbers with Twilio detecting any newly ported numbers, status changes, etc.
    */
    @Route(Path="/phone-numbers/sync", Verbs="POST")
    @Api(Description="Syncs list of phone numbers with Twilio detecting any newly ported numbers, status changes, etc.")
    public static class SyncPhoneNumbers implements IReturn<SyncPhoneNumbersResponse>, IPost
    {
        /**
        * The account ID you want to sync
        */
        @ApiMember(Description="The account ID you want to sync")
        public String accountId = null;
        
        public String getAccountId() { return accountId; }
        public SyncPhoneNumbers setAccountId(String value) { this.accountId = value; return this; }
        private static Object responseType = SyncPhoneNumbersResponse.class;
        public Object getResponseType() { return responseType; }
    }

    public static class SyncPhoneNumbersResponse
    {
        public ArrayList<EndpointInfo> newPhoneNumbers = null;
        public ArrayList<EndpointInfo> updatedPhoneNumbers = null;
        
        public ArrayList<EndpointInfo> getNewPhoneNumbers() { return newPhoneNumbers; }
        public SyncPhoneNumbersResponse setNewPhoneNumbers(ArrayList<EndpointInfo> value) { this.newPhoneNumbers = value; return this; }
        public ArrayList<EndpointInfo> getUpdatedPhoneNumbers() { return updatedPhoneNumbers; }
        public SyncPhoneNumbersResponse setUpdatedPhoneNumbers(ArrayList<EndpointInfo> value) { this.updatedPhoneNumbers = value; return this; }
    }

    public static class EndpointInfo extends EntityInfo
    {
        /**
        * The account ID this endpoint is associated with
        */
        @ApiMember(Description="The account ID this endpoint is associated with")
        public String accountId = null;

        /**
        * The name of the account this endpoint is associated with
        */
        @ApiMember(Description="The name of the account this endpoint is associated with")
        public String accountName = null;

        /**
        * The ID of the customer this endpoint is associated with
        */
        @ApiMember(Description="The ID of the customer this endpoint is associated with")
        public String customerId = null;

        /**
        * The name of the customer this endpoint is associated with
        */
        @ApiMember(Description="The name of the customer this endpoint is associated with")
        public String customerName = null;

        /**
        * The third party reference ID for the endpoint
        */
        @ApiMember(Description="The third party reference ID for the endpoint")
        public String referenceId = null;

        /**
        * The breadcrumb to the customer for this endpoint
        */
        @ApiMember(Description="The breadcrumb to the customer for this endpoint")
        public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;

        /**
        * The display name of the endpoint
        */
        @ApiMember(Description="The display name of the endpoint")
        public String displayName = null;

        /**
        * The type of endpoint
        */
        @ApiMember(Description="The type of endpoint")
        public EndpointTypes type = null;

        /**
        * Extra info for this endpoint (typically to show in grid)
        */
        @ApiMember(Description="Extra info for this endpoint (typically to show in grid)")
        public String extraInformation = null;

        /**
        * The ID of the flow to use for voice
        */
        @ApiMember(Description="The ID of the flow to use for voice")
        public String flowId = null;

        /**
        * The name of the flow to use for voice
        */
        @ApiMember(Description="The name of the flow to use for voice")
        public String flowName = null;

        /**
        * The params for the voice flow
        */
        @ApiMember(Description="The params for the voice flow")
        public Struct flowParams = null;

        /**
        * Whether to use a single flow always or use scheduled flow system
        */
        @ApiMember(Description="Whether to use a single flow always or use scheduled flow system")
        public EndpointFlowSchedules flowSchedule = null;

        /**
        * This endpoint's schedule
        */
        @ApiMember(Description="This endpoint's schedule")
        public Schedule schedule = null;

        /**
        * The list of scheduled flows when using scheduling
        */
        @ApiMember(Description="The list of scheduled flows when using scheduling")
        public ArrayList<ScheduledFlow> scheduledFlows = null;

        /**
        * Disable SMS
        */
        @ApiMember(Description="Disable SMS")
        public Boolean disableSms = null;

        /**
        * Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
        */
        @ApiMember(Description="Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number")
        public Boolean useExternal10DlcCampaign = null;

        /**
        * Is this a virtual phone number?
        */
        @ApiMember(Description="Is this a virtual phone number?")
        public Boolean isVirtualPhoneNumber = null;

        /**
        * Is caller ID verified for this virtual number?
        */
        @ApiMember(Description="Is caller ID verified for this virtual number?")
        public Boolean isCallerIdVerified = null;

        /**
        * The verification code for this number
        */
        @ApiMember(Description="The verification code for this number")
        public String callerIdVerificationCode = null;

        /**
        * The phone number
        */
        @ApiMember(Description="The phone number")
        public String phoneNumber = null;

        /**
        * The Sid of the phone number
        */
        @ApiMember(Description="The Sid of the phone number")
        public String phoneNumberSid = null;

        /**
        * The caller ID Name (CNAM) for the phone number
        */
        @ApiMember(Description="The caller ID Name (CNAM) for the phone number")
        public String callerIdName = null;

        /**
        * The address SID associated with the phone number
        */
        @ApiMember(Description="The address SID associated with the phone number")
        public String addressSid = null;

        /**
        * Do not touch this phone number - for BYOA accounts
        */
        @ApiMember(Description="Do not touch this phone number - for BYOA accounts")
        public Boolean doNotTouchPhoneNumber = null;

        /**
        * Is this number enrolled in a 10DLC messaging service campaign
        */
        @ApiMember(Description="Is this number enrolled in a 10DLC messaging service campaign")
        public Boolean isEnrolledIn10DlcService = null;

        /**
        * Whether we look up caller ID or not
        */
        @ApiMember(Description="Whether we look up caller ID or not")
        public Boolean enableCallerIdLookup = null;

        /**
        * The email address of the user
        */
        @ApiMember(Description="The email address of the user")
        public String userEmailAddress = null;

        /**
        * The Twilio Region for the SIP endpoint
        */
        @ApiMember(Description="The Twilio Region for the SIP endpoint")
        public TwilioSipRegions sipRegion = null;

        /**
        * The Twilio Sid of the credentials for Sip
        */
        @ApiMember(Description="The Twilio Sid of the credentials for Sip")
        public String sipCredentialSid = null;

        /**
        * The Twilio SIP user name
        */
        @ApiMember(Description="The Twilio SIP user name")
        public String sipUserName = null;

        /**
        * The Twilio SIP password
        */
        @ApiMember(Description="The Twilio SIP password")
        public String sipPassword = null;

        /**
        * The SIP domain
        */
        @ApiMember(Description="The SIP domain")
        public String sipDomain = null;

        /**
        * Is emergency calling enabled on this number?
        */
        @ApiMember(Description="Is emergency calling enabled on this number?")
        public Boolean enableEmergencyCalling = null;

        /**
        * The SID of the emergency address for this number
        */
        @ApiMember(Description="The SID of the emergency address for this number")
        public String emergencyAddressSid = null;

        /**
        * The ID of the phone number to use for emergency dialing
        */
        @ApiMember(Description="The ID of the phone number to use for emergency dialing")
        public String emergencyPhoneNumberId = null;

        /**
        * The current agent state of this user endpoint
        */
        @ApiMember(Description="The current agent state of this user endpoint")
        public AgentStates agentState = null;

        /**
        * The current agent state reason of this user endpoint
        */
        @ApiMember(Description="The current agent state reason of this user endpoint")
        public AgentStateReasons agentStateReason = null;

        /**
        * The mode for this user
        */
        @ApiMember(Description="The mode for this user")
        public UserModes userMode = null;

        /**
        * The ID of the file to use for voicemail greeting
        */
        @ApiMember(Description="The ID of the file to use for voicemail greeting")
        public String voicemailGreetingId = null;

        /**
        * The endpoint's data
        */
        @ApiMember(Description="The endpoint's data")
        public Struct data = null;

        /**
        * The email address for email endpoints
        */
        @ApiMember(Description="The email address for email endpoints")
        public String emailAddress = null;

        /**
        * The first name of the user (for user endpoints)
        */
        @ApiMember(Description="The first name of the user (for user endpoints)")
        public String userFirstName = null;

        /**
        * The last name of the user (for user endpoints)
        */
        @ApiMember(Description="The last name of the user (for user endpoints)")
        public String userLastName = null;

        /**
        * The URL of an image for this user's avatar
        */
        @ApiMember(Description="The URL of an image for this user's avatar")
        public String avatarUrl = null;

        /**
        * Does this user have manager role?
        */
        @ApiMember(Description="Does this user have manager role?")
        public UserManagerRoles managerRole = null;

        /**
        * The list of dashboard permissions for when the manager role is custom
        */
        @ApiMember(Description="The list of dashboard permissions for when the manager role is custom")
        public ArrayList<DashboardPermissions> dashboardPermissions = null;

        /**
        * The type of visibility this user has to their own fields
        */
        @ApiMember(Description="The type of visibility this user has to their own fields")
        public UserDataFieldModes myFieldPermissions = null;

        /**
        * The type of visibility this user has to customer fields
        */
        @ApiMember(Description="The type of visibility this user has to customer fields")
        public UserDataFieldModes customerFieldPermissions = null;

        /**
        * The type of visibility this user has to other user fields
        */
        @ApiMember(Description="The type of visibility this user has to other user fields")
        public UserDataFieldModes otherUserFieldPermissions = null;

        /**
        * The type of visibility this user has to other endpoint fields
        */
        @ApiMember(Description="The type of visibility this user has to other endpoint fields")
        public UserDataFieldModes otherEndpointFieldPermissions = null;

        /**
        * The name of this endpoint (for bots etc.)
        */
        @ApiMember(Description="The name of this endpoint (for bots etc.)")
        public String name = null;

        /**
        * The list of tags for this endpoint
        */
        @ApiMember(Description="The list of tags for this endpoint")
        public ArrayList<Tag> tags = null;

        /**
        * The list of action URLs
        */
        @ApiMember(Description="The list of action URLs")
        public ArrayList<EndpointActionUrl> actionUrls = null;

        /**
        * The list of members in this team
        */
        @ApiMember(Description="The list of members in this team")
        public ArrayList<String> teamMemberIds = null;

        /**
        * Visibility of this user/team in contact lists
        */
        @ApiMember(Description="Visibility of this user/team in contact lists")
        public CustomerVisibility contactListVisibility = null;

        /**
        * The list of contacts personal to this user
        */
        @ApiMember(Description="The list of contacts personal to this user")
        public ArrayList<EndpointContact> contacts = null;

        /**
        * The documo ID for this number
        */
        @ApiMember(Description="The documo ID for this number")
        public String documoId = null;

        /**
        * Integration data for this endpoint
        */
        @ApiMember(Description="Integration data for this endpoint")
        public EntityIntegrationData integrationData = null;

        /**
        * Settings for third party phone system
        */
        @ApiMember(Description="Settings for third party phone system")
        public ThirdPartyPhoneSystemSettings thirdPartyPhoneSystemSettings = null;

        /**
        * Should this user override the parent customer's app settings
        */
        @ApiMember(Description="Should this user override the parent customer's app settings")
        public Boolean overrideAppSettings = null;

        /**
        * App / Portal settings for this user
        */
        @ApiMember(Description="App / Portal settings for this user")
        public AppSettings appSettings = null;

        /**
        * Configuration for the AI assistant
        */
        @ApiMember(Description="Configuration for the AI assistant")
        public AssistantSettings assistantSettings = null;

        /**
        * Configuration for the embed
        */
        @ApiMember(Description="Configuration for the embed")
        public EmbedSettings embedSettings = null;
        
        public String getAccountId() { return accountId; }
        public EndpointInfo setAccountId(String value) { this.accountId = value; return this; }
        public String getAccountName() { return accountName; }
        public EndpointInfo setAccountName(String value) { this.accountName = value; return this; }
        public String getCustomerId() { return customerId; }
        public EndpointInfo setCustomerId(String value) { this.customerId = value; return this; }
        public String getCustomerName() { return customerName; }
        public EndpointInfo setCustomerName(String value) { this.customerName = value; return this; }
        public String getReferenceId() { return referenceId; }
        public EndpointInfo setReferenceId(String value) { this.referenceId = value; return this; }
        public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
        public EndpointInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
        public String getDisplayName() { return displayName; }
        public EndpointInfo setDisplayName(String value) { this.displayName = value; return this; }
        public EndpointTypes getType() { return type; }
        public EndpointInfo setType(EndpointTypes value) { this.type = value; return this; }
        public String getExtraInformation() { return extraInformation; }
        public EndpointInfo setExtraInformation(String value) { this.extraInformation = value; return this; }
        public String getFlowId() { return flowId; }
        public EndpointInfo setFlowId(String value) { this.flowId = value; return this; }
        public String getFlowName() { return flowName; }
        public EndpointInfo setFlowName(String value) { this.flowName = value; return this; }
        public Struct getFlowParams() { return flowParams; }
        public EndpointInfo setFlowParams(Struct value) { this.flowParams = value; return this; }
        public EndpointFlowSchedules getFlowSchedule() { return flowSchedule; }
        public EndpointInfo setFlowSchedule(EndpointFlowSchedules value) { this.flowSchedule = value; return this; }
        public Schedule getSchedule() { return schedule; }
        public EndpointInfo setSchedule(Schedule value) { this.schedule = value; return this; }
        public ArrayList<ScheduledFlow> getScheduledFlows() { return scheduledFlows; }
        public EndpointInfo setScheduledFlows(ArrayList<ScheduledFlow> value) { this.scheduledFlows = value; return this; }
        public Boolean isDisableSms() { return disableSms; }
        public EndpointInfo setDisableSms(Boolean value) { this.disableSms = value; return this; }
        public Boolean isUseExternal10DlcCampaign() { return useExternal10DlcCampaign; }
        public EndpointInfo setUseExternal10DlcCampaign(Boolean value) { this.useExternal10DlcCampaign = value; return this; }
        public Boolean getIsVirtualPhoneNumber() { return isVirtualPhoneNumber; }
        public EndpointInfo setIsVirtualPhoneNumber(Boolean value) { this.isVirtualPhoneNumber = value; return this; }
        public Boolean getIsCallerIdVerified() { return isCallerIdVerified; }
        public EndpointInfo setIsCallerIdVerified(Boolean value) { this.isCallerIdVerified = value; return this; }
        public String getCallerIdVerificationCode() { return callerIdVerificationCode; }
        public EndpointInfo setCallerIdVerificationCode(String value) { this.callerIdVerificationCode = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public EndpointInfo setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getPhoneNumberSid() { return phoneNumberSid; }
        public EndpointInfo setPhoneNumberSid(String value) { this.phoneNumberSid = value; return this; }
        public String getCallerIdName() { return callerIdName; }
        public EndpointInfo setCallerIdName(String value) { this.callerIdName = value; return this; }
        public String getAddressSid() { return addressSid; }
        public EndpointInfo setAddressSid(String value) { this.addressSid = value; return this; }
        public Boolean isDoNotTouchPhoneNumber() { return doNotTouchPhoneNumber; }
        public EndpointInfo setDoNotTouchPhoneNumber(Boolean value) { this.doNotTouchPhoneNumber = value; return this; }
        public Boolean getIsEnrolledIn10DlcService() { return isEnrolledIn10DlcService; }
        public EndpointInfo setIsEnrolledIn10DlcService(Boolean value) { this.isEnrolledIn10DlcService = value; return this; }
        public Boolean isEnableCallerIdLookup() { return enableCallerIdLookup; }
        public EndpointInfo setEnableCallerIdLookup(Boolean value) { this.enableCallerIdLookup = value; return this; }
        public String getUserEmailAddress() { return userEmailAddress; }
        public EndpointInfo setUserEmailAddress(String value) { this.userEmailAddress = value; return this; }
        public TwilioSipRegions getSipRegion() { return sipRegion; }
        public EndpointInfo setSipRegion(TwilioSipRegions value) { this.sipRegion = value; return this; }
        public String getSipCredentialSid() { return sipCredentialSid; }
        public EndpointInfo setSipCredentialSid(String value) { this.sipCredentialSid = value; return this; }
        public String getSipUserName() { return sipUserName; }
        public EndpointInfo setSipUserName(String value) { this.sipUserName = value; return this; }
        public String getSipPassword() { return sipPassword; }
        public EndpointInfo setSipPassword(String value) { this.sipPassword = value; return this; }
        public String getSipDomain() { return sipDomain; }
        public EndpointInfo setSipDomain(String value) { this.sipDomain = value; return this; }
        public Boolean isEnableEmergencyCalling() { return enableEmergencyCalling; }
        public EndpointInfo setEnableEmergencyCalling(Boolean value) { this.enableEmergencyCalling = value; return this; }
        public String getEmergencyAddressSid() { return emergencyAddressSid; }
        public EndpointInfo setEmergencyAddressSid(String value) { this.emergencyAddressSid = value; return this; }
        public String getEmergencyPhoneNumberId() { return emergencyPhoneNumberId; }
        public EndpointInfo setEmergencyPhoneNumberId(String value) { this.emergencyPhoneNumberId = value; return this; }
        public AgentStates getAgentState() { return agentState; }
        public EndpointInfo setAgentState(AgentStates value) { this.agentState = value; return this; }
        public AgentStateReasons getAgentStateReason() { return agentStateReason; }
        public EndpointInfo setAgentStateReason(AgentStateReasons value) { this.agentStateReason = value; return this; }
        public UserModes getUserMode() { return userMode; }
        public EndpointInfo setUserMode(UserModes value) { this.userMode = value; return this; }
        public String getVoicemailGreetingId() { return voicemailGreetingId; }
        public EndpointInfo setVoicemailGreetingId(String value) { this.voicemailGreetingId = value; return this; }
        public Struct getData() { return data; }
        public EndpointInfo setData(Struct value) { this.data = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public EndpointInfo setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getUserFirstName() { return userFirstName; }
        public EndpointInfo setUserFirstName(String value) { this.userFirstName = value; return this; }
        public String getUserLastName() { return userLastName; }
        public EndpointInfo setUserLastName(String value) { this.userLastName = value; return this; }
        public String getAvatarUrl() { return avatarUrl; }
        public EndpointInfo setAvatarUrl(String value) { this.avatarUrl = value; return this; }
        public UserManagerRoles getManagerRole() { return managerRole; }
        public EndpointInfo setManagerRole(UserManagerRoles value) { this.managerRole = value; return this; }
        public ArrayList<DashboardPermissions> getDashboardPermissions() { return dashboardPermissions; }
        public EndpointInfo setDashboardPermissions(ArrayList<DashboardPermissions> value) { this.dashboardPermissions = value; return this; }
        public UserDataFieldModes getMyFieldPermissions() { return myFieldPermissions; }
        public EndpointInfo setMyFieldPermissions(UserDataFieldModes value) { this.myFieldPermissions = value; return this; }
        public UserDataFieldModes getCustomerFieldPermissions() { return customerFieldPermissions; }
        public EndpointInfo setCustomerFieldPermissions(UserDataFieldModes value) { this.customerFieldPermissions = value; return this; }
        public UserDataFieldModes getOtherUserFieldPermissions() { return otherUserFieldPermissions; }
        public EndpointInfo setOtherUserFieldPermissions(UserDataFieldModes value) { this.otherUserFieldPermissions = value; return this; }
        public UserDataFieldModes getOtherEndpointFieldPermissions() { return otherEndpointFieldPermissions; }
        public EndpointInfo setOtherEndpointFieldPermissions(UserDataFieldModes value) { this.otherEndpointFieldPermissions = value; return this; }
        public String getName() { return name; }
        public EndpointInfo setName(String value) { this.name = value; return this; }
        public ArrayList<Tag> getTags() { return tags; }
        public EndpointInfo setTags(ArrayList<Tag> value) { this.tags = value; return this; }
        public ArrayList<EndpointActionUrl> getActionUrls() { return actionUrls; }
        public EndpointInfo setActionUrls(ArrayList<EndpointActionUrl> value) { this.actionUrls = value; return this; }
        public ArrayList<String> getTeamMemberIds() { return teamMemberIds; }
        public EndpointInfo setTeamMemberIds(ArrayList<String> value) { this.teamMemberIds = value; return this; }
        public CustomerVisibility getContactListVisibility() { return contactListVisibility; }
        public EndpointInfo setContactListVisibility(CustomerVisibility value) { this.contactListVisibility = value; return this; }
        public ArrayList<EndpointContact> getContacts() { return contacts; }
        public EndpointInfo setContacts(ArrayList<EndpointContact> value) { this.contacts = value; return this; }
        public String getDocumoId() { return documoId; }
        public EndpointInfo setDocumoId(String value) { this.documoId = value; return this; }
        public EntityIntegrationData getIntegrationData() { return integrationData; }
        public EndpointInfo setIntegrationData(EntityIntegrationData value) { this.integrationData = value; return this; }
        public ThirdPartyPhoneSystemSettings getThirdPartyPhoneSystemSettings() { return thirdPartyPhoneSystemSettings; }
        public EndpointInfo setThirdPartyPhoneSystemSettings(ThirdPartyPhoneSystemSettings value) { this.thirdPartyPhoneSystemSettings = value; return this; }
        public Boolean isOverrideAppSettings() { return overrideAppSettings; }
        public EndpointInfo setOverrideAppSettings(Boolean value) { this.overrideAppSettings = value; return this; }
        public AppSettings getAppSettings() { return appSettings; }
        public EndpointInfo setAppSettings(AppSettings value) { this.appSettings = value; return this; }
        public AssistantSettings getAssistantSettings() { return assistantSettings; }
        public EndpointInfo setAssistantSettings(AssistantSettings value) { this.assistantSettings = value; return this; }
        public EmbedSettings getEmbedSettings() { return embedSettings; }
        public EndpointInfo setEmbedSettings(EmbedSettings value) { this.embedSettings = value; return this; }
    }

}