"""
Common date types and APIs
"""
from datetime import datetime
from typing import Optional, Any
from pydantic import Field, root_validator, validator
from ..base import ApiModel, webex_id_to_uuid
from ..base import SafeEnum as Enum
__all__ = ['UserType', 'UserBase', 'RingPattern', 'AlternateNumber', 'Greeting', 'UserNumber', 'PersonPlaceAgent',
'MonitoredMember', 'CallParkExtension', 'AuthCode', 'RouteType', 'DialPatternValidate', 'DialPatternStatus',
'RouteIdentity', 'Customer', 'IdOnly', 'IdAndName', 'PatternAction', 'NumberState', 'ValidationStatus',
'ValidateExtensionStatusState', 'ValidateExtensionStatus', 'ValidateExtensionsResponse',
'ValidatePhoneNumberStatusState', 'ValidatePhoneNumberStatus', 'ValidatePhoneNumbersResponse', 'StorageType',
'VoicemailMessageStorage', 'VoicemailEnabled', 'VoicemailNotifications', 'VoicemailFax',
'VoicemailTransferToNumber', 'VoicemailCopyOfMessage', 'AudioCodecPriority', 'AtaDtmfMode', 'AtaDtmfMethod',
'VlanSetting', 'AtaCustomization', 'DeviceCustomizations', 'DeviceCustomization',
'CommonDeviceCustomization', 'BacklightTimer', 'Background', 'BackgroundSelection', 'DisplayNameSelection',
'LoggingLevel', 'DisplayCallqueueAgentSoftkey', 'AcdCustomization', 'LineKeyLabelSelection',
'LineKeyLedPattern', 'PhoneLanguage', 'ScreenTimeout', 'WifiNetwork', 'MppCustomization', 'PrimaryOrShared',
'MediaFileType', 'AnnAudioFile', 'WifiCustomization', 'RoomType']
[docs]class RoomType(str, Enum):
#: 1:1 room.
direct = 'direct'
#: Group room.
group = 'group'
[docs]class UserType(str, Enum):
people = 'PEOPLE'
place = 'PLACE'
virtual_line = 'VIRTUAL_LINE'
[docs]class UserBase(ApiModel):
first_name: Optional[str]
last_name: Optional[str]
user_type: Optional[UserType] = Field(alias='type')
[docs]class RingPattern(str, Enum):
"""
Ring Pattern
"""
#: Normal incoming ring pattern.
normal = 'NORMAL'
#: Incoming ring pattern of two long rings.
long_long = 'LONG_LONG'
#: Incoming ring pattern of two short rings, followed by a short ring.
short_short_long = 'SHORT_SHORT_LONG'
#: Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.
short_long_short = 'SHORT_LONG_SHORT'
[docs]class AlternateNumber(ApiModel):
"""
Hunt group or call queue alternate number
"""
#: Alternate phone number for the hunt group or call queue
phone_number: Optional[str]
#: Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the
#: hunt group.
ring_pattern: Optional[RingPattern]
#: Flag: phone_number is a toll free number
toll_free_number: Optional[bool]
[docs]class Greeting(str, Enum):
"""
DEFAULT indicates that a system default message will be placed when incoming calls are intercepted.
"""
#: A custom will be placed when incoming calls are intercepted.
custom = 'CUSTOM'
#: A System default message will be placed when incoming calls are intercepted.
default = 'DEFAULT'
[docs]class UserNumber(ApiModel):
"""
phone number of the person or workspace.
"""
#: Phone number of person or workspace. Either phoneNumber or extension is mandatory
external: Optional[str]
#: Extension of person or workspace. Either phoneNumber or extension is mandatory.
extension: Optional[str]
#: Flag to indicate primary phone.
primary: Optional[bool]
[docs]class PersonPlaceAgent(UserBase):
"""
Agent (person or place)
"""
#: ID of person or workspace.
agent_id: str = Field(alias='id')
#: Display name of person or workspace.
display_name: Optional[str]
#: Email of the person or workspace.
email: Optional[str]
#: List of phone numbers of the person or workspace.
numbers: Optional[list[UserNumber]]
[docs]class MonitoredMember(ApiModel):
"""
a monitored user or place
"""
#: The identifier of the monitored person.
member_id: Optional[str] = Field(alias='id')
#: The last name of the monitored person or place.
last_name: Optional[str]
#: The first name of the monitored person or place.
first_name: Optional[str]
#: The display name of the monitored person or place.
display_name: Optional[str]
#: Indicates whether type is PEOPLE or PLACE.
member_type: Optional[UserType] = Field(alias='type')
#: The email address of the monitored person or place.
email: Optional[str]
#: The list of phone numbers of the monitored person or place.
numbers: Optional[list[UserNumber]]
@property
def ci_member_id(self) -> Optional[str]:
return self.member_id and webex_id_to_uuid(self.member_id)
[docs]class CallParkExtension(ApiModel):
#: The identifier of the call park extension.
cpe_id: Optional[str] = Field(alias='id')
#: The name to describe the call park extension.
name: Optional[str]
#: The extension number for this call park extension.
extension: Optional[str]
#: The location name where the call park extension is.
location_name: Optional[str]
#: The location ID for the location.
location_id: Optional[str]
@root_validator(pre=True)
def fix_location_name(cls, values):
"""
:meta private:
:param values:
:return:
"""
location = values.pop('location', None)
if location is not None:
values['location_name'] = location
return values
@property
def ci_cpe_id(self) -> Optional[str]:
"""
call park extension ID as UUID
"""
return self.cpe_id and webex_id_to_uuid(self.cpe_id)
[docs]class AuthCode(ApiModel):
"""
authorization codea and description.
"""
#: Indicates an authorization code.
code: str
#: Indicates the description of the authorization code.
description: str
[docs]class RouteType(str, Enum):
#: Route group must include at least one trunk with a maximum of 10 trunks per route group.
route_group = 'ROUTE_GROUP'
# Connection between Webex Calling and the premises.
trunk = 'TRUNK'
[docs]class DialPatternStatus(str, Enum):
"""
validation status.
"""
#: invalid pattern
invalid = 'INVALID'
#: duplicate pattern
duplicate = 'DUPLICATE'
#: duplicate in input
duplicate_in_list = 'DUPLICATE_IN_LIST'
[docs]class DialPatternValidate(ApiModel):
#: input dial pattern that is being validate
dial_pattern: str
#: validation status.
pattern_status: DialPatternStatus
#: failure details.
message: str
[docs]class RouteIdentity(ApiModel):
route_id: str = Field(alias='id')
name: Optional[str]
route_type: RouteType = Field(alias='type')
[docs]class Customer(ApiModel):
"""
Customer information.
"""
#: ID of the customer/organization.
customer_id: str = Field(alias='id')
#: Name of the customer/organization.
name: str
[docs]class IdOnly(ApiModel):
id: str
[docs]class IdAndName(IdOnly):
name: str
[docs]class PatternAction(str, Enum):
#: add action, when adding a new dial pattern
add = 'ADD'
#: delete action, when deleting an existing dial pattern
delete = 'DELETE'
[docs]class NumberState(str, Enum):
active = 'ACTIVE'
inactive = 'INACTIVE'
[docs]class ValidationStatus(str, Enum):
ok = 'OK'
errors = 'ERRORS'
[docs]class ValidateExtensionStatusState(str, Enum):
valid = 'VALID'
duplicate = 'DUPLICATE'
duplicate_in_list = 'DUPLICATE_IN_LIST'
invalid = 'INVALID'
[docs]class ValidateExtensionStatus(ApiModel):
#: Indicates the extension id for which the status is about .
extension: str
#: Indicate the status for the given extension id .
state: ValidateExtensionStatusState
#: Error Code .
error_code: Optional[int]
message: Optional[str]
@property
def ok(self):
return self.state == ValidateExtensionStatusState.valid
[docs]class ValidateExtensionsResponse(ApiModel):
status: ValidationStatus
extension_status: Optional[list[ValidateExtensionStatus]]
@property
def ok(self) -> bool:
return self.status == ValidationStatus.ok
[docs]class ValidatePhoneNumberStatusState(str, Enum):
#: This means the phone number is available.
available = 'Available'
#: This means it's a duplicate phone number.
duplicate = 'Duplicate'
#: This means it's a duplicate phone number in the list.
duplicate_in_list = 'Duplicate In List'
#: The phone number is invalid.
invalid = 'Invalid'
#: This phone number is unavailable and cannot be used.
unavailable = 'Unavailable'
[docs]class ValidatePhoneNumberStatus(ApiModel):
#: Phone number that need to be validated.
phone_number: str
#: This indicates the state of the number.
state: ValidatePhoneNumberStatusState
#: This indicated whether it's a toll-free number
toll_free_number: bool
#: This field has the details if error if the number is unavailable.
detail: list[str] = Field(default_factory=list)
@property
def ok(self):
return self.state == ValidatePhoneNumberStatusState.available
[docs]class ValidatePhoneNumbersResponse(ApiModel):
#: This indicates the status of the numbers.
status: ValidationStatus
#: This is an array of number objects with number details.
phone_numbers: Optional[list[ValidatePhoneNumberStatus]]
@property
def ok(self) -> bool:
return self.status == ValidationStatus.ok
[docs]class StorageType(str, Enum):
"""
Designates which type of voicemail message storage is used.
"""
#: For message access via phone or the Calling User Portal.
internal = 'INTERNAL'
#: For sending all messages to the person's email.
external = 'EXTERNAL'
[docs]class VoicemailMessageStorage(ApiModel):
"""
Settings for message storage
"""
#: When true desktop phone will indicate there are new voicemails.
mwi_enabled: Optional[bool]
#: Designates which type of voicemail message storage is used.
storage_type: Optional[StorageType]
#: External email address to which the new voicemail audio will be sent. A value for this field must be provided
# in the request if a storageType of EXTERNAL is given in the request.
external_email: Optional[str]
[docs]class VoicemailEnabled(ApiModel):
enabled: bool
[docs]class VoicemailNotifications(VoicemailEnabled):
"""
Settings for notifications when there are any new voicemails.
"""
#: Email address to which the notification will be sent. For text messages, use an email to text message gateway
#: like 2025551212@txt.att.net.
destination: Optional[str]
[docs]class VoicemailFax(VoicemailEnabled):
"""
Fax message settings
"""
#: Designates optional extension for fax.
extension: Optional[str]
#: Designates phone number for fax. A value for this field must be provided in the request if faxMessage enabled
#: field is given as true in the request.
phone_number: Optional[str]
[docs]class VoicemailTransferToNumber(VoicemailEnabled):
"""
Settings for voicemail caller to transfer to a different number by pressing zero (0).
"""
#: Number voicemail caller will be transferred to when they press zero (0).
destination: Optional[str]
[docs]class VoicemailCopyOfMessage(VoicemailEnabled):
"""
Settings for sending a copy of new voicemail message audio via email.
"""
#: Email address to which the new voicemail audio will be sent.
email_id: Optional[str]
[docs]class AudioCodecPriority(ApiModel):
"""
Choose up to three predefined codec priority options available for your region.
"""
#: Indicates the selection of an Audio Code Priority Object.
selection: str
#: Indicates the primary Audio Codec.
primary: Optional[str]
#: Indicates the secondary Audio Codec.
secondary: Optional[str]
#: Indicates the tertiary Audio Codec.
tertiary: Optional[str]
[docs]class AtaDtmfMode(str, Enum):
"""
DTMF Detection Tx Mode selection for Cisco ATA devices.
"""
#: It means a) DTMF digit requires an extra hold time after detection and b) DTMF level threshold is raised to
#: -20 dBm.
strict = 'STRICT'
#: It means normal threshold mode.
normal = 'NORMAL'
[docs]class AtaDtmfMethod(str, Enum):
"""
Method for transmitting DTMF signals to the far end.
"""
#: Sends DTMF by using the audio path.
inband = 'INBAND'
#: Audio video transport. Sends DTMF as AVT events.
avt = 'AVT'
auto = 'AUTO'
[docs]class VlanSetting(ApiModel):
#: Denotes whether the VLAN object is enabled
enabled: bool
#: The value of the VLAN Object
value: int
#: Indicates the PC port value of a VLAN object for an MPP object
pc_port: Optional[int]
[docs]class CommonDeviceCustomization(ApiModel):
#: Choose up to three predefined codec priority options available for your region.
audio_codec_priority: AudioCodecPriority
#: Enable/disable Cisco Discovery Protocol for local devices.
cdp_enabled: bool
#: Enable/disable Link Layer Discovery Protocol for local devices.
lldp_enabled: bool
#: Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform.
qos_enabled: bool
#: Specify a numeric Virtual LAN ID for devices.
vlan: VlanSetting
[docs]class AtaCustomization(CommonDeviceCustomization):
"""
settings that are applicable to ATA devices.
"""
#: DTMF Detection Tx Mode selection for Cisco ATA devices.
ata_dtmf_mode: AtaDtmfMode
#: Method for transmitting DTMF signals to the far end.
ata_dtmf_method: AtaDtmfMethod
snmp: dict
[docs]class BacklightTimer(str, Enum):
one_m = 'ONE_M'
five_m = 'FIVE_M'
thirty_m = 'THIRTY_M'
always_on = 'ALWAYS_ON'
off = 'OFF'
[docs]class Background(str, Enum):
#: Indicates that there will be no background image set for the devices.
no_background = 'NONE'
#: Indicates that dark blue background image will be set for the devices.
dark_blue = 'DARK_BLUE'
#: Indicates that Cisco themed dark blue background image will be set for the devices.
cisco_dark_blue = 'CISCO_DARK_BLUE'
#: Indicates that Cisco webex dark blue background image will be set for the devices.
webex_dark_blue = 'WEBEX_DARK_BLUE'
#: Indicates that a custom background image will be set for the devices.
custom_background = 'CUSTOM_BACKGROUND'
[docs]class BackgroundSelection(ApiModel):
"""
Background selection for MPP devices
"""
image: Background
custom_url: Optional[str]
[docs]class DisplayNameSelection(str, Enum):
#: Indicates that devices will display the person’s phone number, or if a person doesn’t have a phone number, the
#: location number will be displayed.
person_number = 'PERSON_NUMBER'
#: Indicates that devices will display the name in first name then last name format.
person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'
#: Indicates that devices will display the name in last name then first name format.
person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'
[docs]class LoggingLevel(str, Enum):
#: Enables standard logging.
standard = 'STANDARD'
#: Enables detailed debugging logging.
debugging = 'DEBUGGING'
[docs]class DisplayCallqueueAgentSoftkey(str, Enum):
"""
Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.
"""
front_page = 'FRONT_PAGE'
last_page = 'LAST_PAGE'
[docs]class AcdCustomization(ApiModel):
#: Indicates whether the ACD object is enabled.
enabled: bool
#: Indicates the call queue agent soft key value of an ACD object.
display_callqueue_agent_softkeys: str
[docs]class LineKeyLabelSelection(str, Enum):
"""
Line key labels define the format of what’s shown next to line keys.
"""
#: This will display the person extension, or if a person doesn’t have an extension, the person’s first name will
#: be displayed.
person_extension = 'PERSON_EXTENSION'
#: Indicates that devices will display the name in first name then last name format.
person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'
#: Indicates that devices will display the name in last name then first name format.
person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'
[docs]class LineKeyLedPattern(str, Enum):
default = 'DEFAULT'
preset_1 = 'PRESET_1'
[docs]class PhoneLanguage(str, Enum):
#: Indicates a person's announcement language.
person = 'PERSON_LANGUAGE'
arabic = 'ARABIC'
bulgarian = 'BULGARIAN'
catalan = 'CATALAN'
chinese_simplified = 'CHINESE_SIMPLIFIED'
chinese_traditional = 'CHINESE_TRADITIONAL'
croatian = 'CROATIAN'
czech = 'CZECH'
danish = 'DANISH'
dutch = 'DUTCH'
english_united_states = 'ENGLISH_UNITED_STATES'
english_united_kingdom = 'ENGLISH_UNITED_KINGDOM'
finnish = 'FINNISH'
french_canada = 'FRENCH_CANADA'
french_france = 'FRENCH_FRANCE'
german = 'GERMAN'
greek = 'GREEK'
hebrew = 'HEBREW'
hungarian = 'HUNGARIAN'
italian = 'ITALIAN'
japanese = 'JAPANESE'
korean = 'KOREAN'
norwegian = 'NORWEGIAN'
polish = 'POLISH'
portuguese_portugal = 'PORTUGUESE_PORTUGAL'
russian = 'RUSSIAN'
spanish_colombia = 'SPANISH_COLOMBIA'
spanish_spain = 'SPANISH_SPAIN'
slovak = 'SLOVAK'
swedish = 'SWEDISH'
slovenian = 'SLOVENIAN'
turkish = 'TURKISH'
ukraine = 'UKRAINE'
[docs]class ScreenTimeout(ApiModel):
"""
Specify the amount of inactive time needed (in seconds) before the phone’s screen saver activates.
"""
#: Indicates whether the Screen Time object is enabled.
enabled: bool
#: Indicates the value of screen timeout.
value: int
[docs]class WifiNetwork(ApiModel):
"""
Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
"""
#: Indicates whether the wifi network is enabled.
enabled: bool
#: Authentication method of wifi network.
authentication_method: str
#: SSID name of the wifi network.
ssid_name: Optional[str]
#: User ID of the wifi network.
user_id: Optional[str]
[docs]class MppCustomization(CommonDeviceCustomization):
"""
settings that are applicable to MPP devices.
"""
#: Indicates whether PNAC of MPP object is enabled or not
pnac_enabled: bool
#: Choose the length of time (in minutes) for the phone’s backlight to remain on.
backlight_timer: BacklightTimer
#: Holds the background object of MPP Object.
background: BackgroundSelection
#: The display name that appears on the phone screen.
display_name_format: DisplayNameSelection
#: Choose the desired logging level for an MPP devices
default_logging_level: LoggingLevel
#: Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones.
dnd_services_enabled: bool
#: Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.
display_callqueue_agent_softkeys: Optional[DisplayCallqueueAgentSoftkey]
#: Choose the duration (in hours) of Hoteling guest login.
hoteling_guest_association_timer: Optional[int]
acd: AcdCustomization
#: Indicates the short inter digit timer value.
short_interdigit_timer: int
#: Indicates the long inter digit timer value.
long_interdigit_timer: int
#: Line key labels define the format of what’s shown next to line keys.
line_key_label_format: LineKeyLabelSelection
#: LED patterns define lighting schemes for the line keys on the MPP devices. Note – This parameter is not
#: supported on the MPP 8875
line_key_led_pattern: LineKeyLedPattern = Field(alias='lineKeyLEDPattern')
#: Enable/disable user-level access to the web interface of Multi-Platform Phones.
mpp_user_web_access_enabled: bool
#: Select up to 10 Multicast Group URLs (each with a unique Listening Port).
multicast: Optional[list[str]]
#: Specify the amount of time (in seconds) that a phone can remain off-hook.
off_hook_timer: int
#: Select the language for your MPP phone. Setting this overrides the default language setting in place for your
#: provisioned location.
phone_language: PhoneLanguage
#: Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones.
poe_mode: str
#: Specify the amount of inactive time needed (in seconds) before the phone’s screen saver activates.
screen_timeout: ScreenTimeout
#: Enable/disable the use of the USB ports on Multi-Platform phones.
usb_ports_enabled: Optional[bool]
#: Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
wifi_network: WifiNetwork
[docs]class WifiCustomization(ApiModel):
# TODO: implement as soon as properly documented on developer.webex.com
#: Choose up to three predefined codec priority options available for your region.
audio_codec_priority: AudioCodecPriority
ldap: Any
web_access: Any
[docs]class DeviceCustomizations(ApiModel):
"""
Customization object of the device settings.
At the device level only one of ata, dect, and mpp is set. At location and org level all three
customizations are set.
"""
ata: Optional[AtaCustomization]
dect: Optional[CommonDeviceCustomization]
mpp: Optional[MppCustomization]
wifi: Optional[WifiCustomization]
[docs]class DeviceCustomization(ApiModel):
"""
Device customization
"""
@validator('last_update_time', pre=True)
def update_time(cls, v):
"""
:meta private:
"""
if not v:
return v
try:
v = datetime.fromtimestamp(v / 1000)
finally:
pass
return v
#: customization object of the device settings.
customizations: DeviceCustomizations
#: Indicates if customization is allowed at repective (location or device) level.
#: If true - customized at this level.
#: If false - not customized, using higher level config (location or org).
#: Only present in location and device level customization response
custom_enabled: Optional[bool]
#: Indicates the progress of the device update. Not present at device level
update_in_progress: Optional[bool]
#: Indicates the device count. Not present at device level
device_count: Optional[int]
#: Indicates the last updated time.
last_update_time: Optional[datetime]
[docs]class PrimaryOrShared(str, Enum):
#: This indicates a Primary line for the member
primary = 'PRIMARY'
#: This indicates a Shared line for the member. Shared line appearance allows users to receive and place calls to
#: and from another user's extension, using their device.
shared = 'SHARED_CALL_APPEARANCE'
mobility = 'MOBILITY'
[docs]class AnnAudioFile(ApiModel):
"""
Announcement Audio Files
"""
#: Name of the file.
file_name: str
#: Media Type of the audio file.
media_file_type: MediaFileType