"""
Call forwarding API
"""
from typing import Optional
from ..base import ApiModel
from .common import PersonSettingsApiChild
__all__ = ['CallForwardingCommon', 'CallForwardingAlways', 'CallForwardingNoAnswer', 'CallForwardingPerson',
'PersonForwardingSetting', 'PersonForwardingApi']
[docs]
class CallForwardingCommon(ApiModel):
"""
Common call forwarding settings
"""
#: call forwarding is enabled or disabled.
enabled: bool
#: Destination for call forwarding.
destination: Optional[str] = None
#: Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal
#: phone number and that number has the voicemail service enabled.
destination_voicemail_enabled: Optional[bool] = None
[docs]
@staticmethod
def default() -> 'CallForwardingCommon':
return CallForwardingCommon(enabled=False, destination='', destination_voicemail_enabled=False)
[docs]
class CallForwardingAlways(CallForwardingCommon):
"""
Settings for forwarding all incoming calls to the destination you choose.
"""
#: If true, a brief tone will be played on the person’s phone when a call has been forwarded.
ring_reminder_enabled: bool
[docs]
@staticmethod
def default() -> 'CallForwardingAlways':
return CallForwardingAlways(enabled=False, destination='', destination_voicemail_enabled=False,
ring_reminder_enabled=False)
[docs]
class CallForwardingNoAnswer(CallForwardingCommon):
#: Number of rings before the call will be forwarded if unanswered.
number_of_rings: int
# System-wide maximum number of rings allowed for numberOfRings setting.
system_max_number_of_rings: Optional[int] = None
[docs]
@staticmethod
def default() -> 'CallForwardingNoAnswer':
return CallForwardingNoAnswer(enabled=False, destination='', destination_voicemail_enabled=False,
number_of_rings=3)
[docs]
class CallForwardingPerson(ApiModel):
"""
Settings related to "Always", "Busy", and "No Answer" call forwarding.
"""
#: Settings for forwarding all incoming calls to the destination you choose.
always: CallForwardingAlways
#: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the person
#: is busy.
busy: CallForwardingCommon
#: Settings for forwarding which only occurs when you are away or not answering your phone.
no_answer: CallForwardingNoAnswer
[docs]
@staticmethod
def default() -> 'CallForwardingPerson':
return CallForwardingPerson(always=CallForwardingAlways.default(),
busy=CallForwardingCommon.default(),
no_answer=CallForwardingNoAnswer.default())
[docs]
class PersonForwardingSetting(ApiModel):
"""
A person's call forwarding setting
"""
#: Settings related to "Always", "Busy", and "No Answer" call forwarding.
call_forwarding: CallForwardingPerson
#: Settings for sending calls to a destination of your choice if your phone is not connected to the network for
#: any reason, such as power outage, failed Internet connection, or wiring problem.
business_continuity: CallForwardingCommon
[docs]
@staticmethod
def default() -> 'PersonForwardingSetting':
return PersonForwardingSetting(call_forwarding=CallForwardingPerson.default(),
business_continuity=CallForwardingCommon.default())
def update(self) -> dict:
"""
data for update
:meta private:
"""
return self.model_dump(mode='json', exclude_unset=True, by_alias=True,
exclude={'call_forwarding': {'no_answer': {'system_max_number_of_rings': True}}})
[docs]
class PersonForwardingApi(PersonSettingsApiChild):
"""
API for person's call forwarding settings
Also used for virtual lines, workspaces
"""
feature = 'callForwarding'
[docs]
def read(self, entity_id: str, org_id: str = None) -> PersonForwardingSetting:
"""
Retrieve an entity's Call Forwarding Settings
Three types of call forwarding are supported:
* Always – forwards all incoming calls to the destination you choose.
* When busy – forwards all incoming calls to the destination you chose while the phone is in use or the person
is busy.
* When no answer – forwarding only occurs when you are away or not answering your phone.
In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is
not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem
This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read
or a user auth token with spark:people_read scope can be used by a person to read their own settings.
:param entity_id: Unique identifier for the entity.
:type entity_id: str
:param org_id: Entity is in this organization. Only admin users of another organization (such as partners)
may use this parameter as the default is the same organization as the token used to access API.
:type org_id: str
:return: user's forwarding settings
:rtype: PersonForwardingSetting
"""
ep = self.f_ep(person_id=entity_id)
params = org_id and {'orgId': org_id} or None
return PersonForwardingSetting.model_validate(self.get(ep, params=params))