catalystwan 0.41.2__py3-none-any.whl → 0.41.2.dev0__py3-none-any.whl

catalystwan/models/configuration/feature_profile/sdwan/uc_voice/call_routing.py

@@ -0,0 +1,179 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from typing import List, Literal, Optional, Union
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.configuration.feature_profile.common import RefIdItem
+
+VoiceType = Literal[
+    "pots",
+    "sip",
+]
+
+TranslationRuleDirection = Literal[
+    "incoming",
+    "outgoing",
+]
+
+FwdDigitChoice = Literal[
+    "all",
+    "none",
+    "some",
+]
+
+TransportChoice = Literal[
+    "tcp",
+    "udp",
+]
+
+
+class Voice(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    dialpeertag: Union[Variable, Global[int]] = Field()
+    call_type: Optional[Global[TranslationRuleDirection]] = Field(
+        default=None, validation_alias="callType", serialization_alias="callType"
+    )
+    description: Optional[Union[Variable, Default[None], Global[str]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "description"),
+    )
+    destination_address: Optional[Union[Variable, Global[str]]] = Field(
+        default=None, validation_alias="destinationAddress", serialization_alias="destinationAddress"
+    )
+    fwd_digit_choice: Optional[Union[Variable, Global[FwdDigitChoice]]] = Field(
+        default=None, validation_alias="fwdDigitChoice", serialization_alias="fwdDigitChoice"
+    )
+    num_digits: Optional[Union[Variable, Global[int]]] = Field(
+        default=None, validation_alias="numDigits", serialization_alias="numDigits"
+    )
+    number_pattern: Optional[Union[Variable, Global[str]]] = Field(
+        default=None, validation_alias="numberPattern", serialization_alias="numberPattern"
+    )
+    port: Optional[Union[Variable, Global[str]]] = Field(default=None)
+    preference: Optional[Union[Variable, Global[int], Default[None]]] = Field(default=None)
+    prefix: Optional[Union[Variable, Global[int], Default[None]]] = Field(default=None)
+    transport_choice: Optional[Union[Variable, Global[TransportChoice], Default[None]]] = Field(
+        default=None, validation_alias="transportChoice", serialization_alias="transportChoice"
+    )
+    type: Optional[Global[VoiceType]] = Field(default=None)
+
+
+Fallback = Literal[
+    "G.711alaw",
+    "G.711ulaw",
+    "None",
+]
+
+
+class ModemPassThrough(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    dial_peer_range: Union[Variable, Global[str]] = Field(
+        validation_alias="dialPeerRange", serialization_alias="dialPeerRange"
+    )
+    protocol: Union[Variable, Global[Fallback]] = Field()
+
+
+Primary = Literal[
+    "Fax Pass-through G711alaw",
+    "Fax Pass-through G711alaw No ECM",
+    "Fax Pass-through G711ulaw",
+    "Fax Pass-through G711ulaw No ECM",
+    "None",
+    "T.38 Fax Relay Version 0",
+    "T.38 Fax Relay Version 0 NSE",
+    "T.38 Fax Relay Version 0 NSE No ECM",
+    "T.38 Fax Relay Version 0 NSE Rate 14.4",
+    "T.38 Fax Relay Version 0 NSE Rate 14.4 No ECM",
+    "T.38 Fax Relay Version 0 NSE Rate 9.6",
+    "T.38 Fax Relay Version 0 NSE Rate 9.6 No ECM",
+    "T.38 Fax Relay Version 0 NSE force",
+    "T.38 Fax Relay Version 0 NSE force No ECM",
+    "T.38 Fax Relay Version 0 NSE force Rate 14.4",
+    "T.38 Fax Relay Version 0 NSE force Rate 14.4 No ECM",
+    "T.38 Fax Relay Version 0 NSE force Rate 9.6",
+    "T.38 Fax Relay Version 0 NSE force Rate 9.6 No ECM",
+    "T.38 Fax Relay Version 0 No ECM",
+    "T.38 Fax Relay Version 0 Rate 14.4",
+    "T.38 Fax Relay Version 0 Rate 14.4 No ECM",
+    "T.38 Fax Relay Version 0 Rate 9.6 No ECM",
+    "T.38 Fax Relay Version 3",
+    "T.38 Fax Relay Version 3 NSE",
+    "T.38 Fax Relay Version 3 NSE force",
+]
+
+
+class FaxProtocol(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    dial_peer_range: Union[Variable, Global[str]] = Field(
+        validation_alias="dialPeerRange", serialization_alias="dialPeerRange"
+    )
+    primary: Union[Variable, Global[Primary]] = Field()
+    fallback: Optional[Union[Variable, Global[Fallback]]] = Field(default=None)
+    high_speed: Optional[Union[Variable, Global[int]]] = Field(
+        default=None, validation_alias="highSpeed", serialization_alias="highSpeed"
+    )
+    low_speed: Optional[Union[Variable, Global[int]]] = Field(
+        default=None, validation_alias="lowSpeed", serialization_alias="lowSpeed"
+    )
+
+
+class Association(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    dial_peer_range: Union[Variable, Global[str]] = Field(
+        validation_alias="dialPeerRange", serialization_alias="dialPeerRange"
+    )
+    media_profile: Optional[RefIdItem] = Field(
+        default=None, validation_alias="mediaProfile", serialization_alias="mediaProfile"
+    )
+    server_group: Optional[RefIdItem] = Field(
+        default=None, validation_alias="serverGroup", serialization_alias="serverGroup"
+    )
+    translation_profile: Optional[RefIdItem] = Field(
+        default=None, validation_alias="translationProfile", serialization_alias="translationProfile"
+    )
+    translation_rule_direction: Optional[Union[Variable, Global[TranslationRuleDirection], Default[None]]] = Field(
+        default=None, validation_alias="translationRuleDirection", serialization_alias="translationRuleDirection"
+    )
+    trunk_group: Optional[RefIdItem] = Field(
+        default=None, validation_alias="trunkGroup", serialization_alias="trunkGroup"
+    )
+    trunk_group_priority: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="trunkGroupPriority", serialization_alias="trunkGroupPriority"
+    )
+    voice_tenant: Optional[RefIdItem] = Field(
+        default=None, validation_alias="voiceTenant", serialization_alias="voiceTenant"
+    )
+
+
+class CallRoutingParcel(_ParcelBase):
+    type_: Literal["call-routing"] = Field(default="call-routing", exclude=True)
+    model_config = ConfigDict(populate_by_name=True)
+    association: Optional[List[Association]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "association"),
+        description="Association",
+    )
+    dial_peer_tag_prefix: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "dialPeerTagPrefix"),
+    )
+    fax_protocol: Optional[List[FaxProtocol]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "faxProtocol"),
+        description="Configure fax protocol",
+    )
+    modem_pass_through: Optional[List[ModemPassThrough]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "modemPassThrough"),
+        description="Configure of Modem Pass-Through",
+    )
+    port_module_location: Optional[RefIdItem] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "portModuleLocation"),
+    )
+    voice: Optional[List[Voice]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "voice"),
+        description="POTS/Voip voice type",
+    )

catalystwan/models/configuration/feature_profile/sdwan/uc_voice/digital_interface.py

@@ -0,0 +1,380 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from typing import List, Literal, Optional, Union
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field, model_validator
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.configuration.feature_profile.common import RefIdItem
+
+VoiceInterfaceTemplates = Literal[
+    "1 Port E1",
+    "1 Port T1",
+    "2 Port E1",
+    "2 Port T1",
+    "4 Port E1",
+    "4 Port T1",
+    "8 Port E1",
+    "8 Port T1",
+]
+
+ModuleLocation = Literal[
+    "0/1",
+    "0/2",
+    "0/3",
+    "1/0",
+    "1/1",
+    "2/0",
+]
+
+ClockType = Literal[
+    "line",
+    "network",
+    "primary",
+    "secondary",
+]
+
+
+class Interface(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    port_id: Global[int] = Field(
+        validation_alias="portId", serialization_alias="portId"
+    )
+    clock_type: Optional[Union[Variable, Default[None], Global[ClockType]]] = Field(
+        default=None, validation_alias="clockType", serialization_alias="clockType"
+    )
+
+
+Framing = Literal[
+    "crc4",
+    "no-crc4",
+    "crc4",
+    "esf",
+    "sf",
+]
+
+
+LineCode = Literal[
+    "ami",
+    "b8zs",
+    "hdb3",
+]
+
+
+CableLengthType = Literal[
+    "long",
+    "short",
+]
+
+
+ShortCableLengthValue = Literal[
+    "-15",
+    "-22.5",
+    "-7.5",
+    "0",
+]
+
+LongCableLengthValue = Literal[
+    "0",
+    "110",
+    "220",
+    "330",
+    "440",
+    "550",
+    "660",
+]
+
+CableLengthValue = Literal[ShortCableLengthValue, LongCableLengthValue]
+
+
+LineTermination = Literal[
+    "120-ohm",
+    "75-ohm",
+]
+
+
+SwitchType = Literal[
+    "primary-4ess",
+    "primary-5ess",
+    "primary-dms100",
+    "primary-net5",
+    "primary-ni",
+    "primary-ntt",
+    "primary-qsig",
+]
+
+
+class BasicSettings(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    delay_connect_timer: Union[Variable, Default[int], Global[int]] = Field(
+        validation_alias="delayConnectTimer", serialization_alias="delayConnectTimer"
+    )
+    framing: Union[Variable, Global[Framing], Default[Framing]] = Field()
+    line_code: Union[Variable, Default[LineCode], Global[LineCode]] = Field(
+        validation_alias="lineCode", serialization_alias="lineCode"
+    )
+    network_side: Union[Variable, Default[bool], Global[bool]] = Field(
+        validation_alias="networkSide", serialization_alias="networkSide"
+    )
+    port_range: Union[Variable, Global[str]] = Field(validation_alias="portRange", serialization_alias="portRange")
+    switch_type: Union[Variable, Global[SwitchType], Default[SwitchType]] = Field(
+        validation_alias="switchType", serialization_alias="switchType"
+    )
+    cable_length: Optional[Union[Variable, Default[Literal["0"]], Global[CableLengthValue]]] = Field(
+        default=None, validation_alias="cableLength", serialization_alias="cableLength"
+    )
+    cable_length_type: Optional[Union[Variable, Default[Literal["long"]], Global[CableLengthType]]] = Field(
+        default=None, validation_alias="cableLengthType", serialization_alias="cableLengthType"
+    )
+    framing_australia: Optional[Union[Variable, Default[bool], Global[bool]]] = Field(
+        default=None, validation_alias="framingAustralia", serialization_alias="framingAustralia"
+    )
+    line_termination: Optional[Union[Variable, Default[Literal["120-ohm"]], Global[LineTermination]]] = Field(
+        default=None, validation_alias="lineTermination", serialization_alias="lineTermination"
+    )
+    timeslots: Optional[Global[str]] = Field(default=None)
+
+
+TypeAndTimerType = Literal[
+    "T200",
+    "T203",
+    "T301",
+    "T303",
+    "T306",
+    "T309",
+    "T310",
+    "T321",
+]
+
+
+class TypeAndTimer(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    timer: Union[Variable, Global[int]] = Field()
+    type: Union[Variable, Global[TypeAndTimerType]] = Field()
+
+
+class IsdnTimer(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    port_range: Optional[Union[Variable, Global[str]]] = Field(
+        default=None, validation_alias="portRange", serialization_alias="portRange"
+    )
+    type_and_timer: Optional[List[TypeAndTimer]] = Field(
+        default=None,
+        validation_alias="typeAndTimer",
+        serialization_alias="typeAndTimer",
+        description="list of ISDN Type and Timers",
+    )
+
+
+Plan = Literal[
+    "data",
+    "isdn",
+    "national",
+    "privacy",
+    "reserved/10",
+    "reserved/11",
+    "reserved/12",
+    "reserved/13",
+    "reserved/14",
+    "reserved/2",
+    "reserved/5",
+    "reserved/6",
+    "reserved/7",
+    "telex",
+    "unknown",
+]
+
+IsdnMapType = Literal[
+    "abbreviated",
+    "international",
+    "national",
+    "reserved/5",
+    "subscriber",
+    "unknown",
+]
+
+
+class IsdnMap(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    digit_range: Union[Variable, Global[str]] = Field(validation_alias="digitRange", serialization_alias="digitRange")
+    plan: Union[Variable, Default[None], Global[Plan]] = Field()
+    port_range: Union[Variable, Global[str]] = Field(validation_alias="portRange", serialization_alias="portRange")
+    type: Union[Variable, Default[None], Global[IsdnMapType]] = Field()
+
+
+class Shutdown(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    controller: Union[Variable, Default[bool], Global[bool]] = Field()
+    port_id: Global[int] = Field(
+        validation_alias="portId", serialization_alias="portId"
+    )
+    serial: Union[Variable, Default[bool], Global[bool]] = Field()
+    voice_port: Union[Variable, Default[bool], Global[bool]] = Field(
+        validation_alias="voicePort", serialization_alias="voicePort"
+    )
+
+
+CompandType = Literal[
+    "a-law",
+    "u-law",
+]
+
+
+class LineParams(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    port_range: Union[Variable, Global[str]] = Field(validation_alias="portRange", serialization_alias="portRange")
+    attenuation: Optional[Union[Variable, Default[int], Global[int]]] = Field(default=None)
+    call_progress_tone: Optional[Union[Variable, Global[None], Default[None]]] = Field(
+        default=None, validation_alias="callProgressTone", serialization_alias="callProgressTone"
+    )
+    compand_type: Optional[Union[Variable, Default[CompandType], Global[CompandType]]] = Field(
+        default=None, validation_alias="compandType", serialization_alias="compandType"
+    )
+    echo_canceller: Optional[Union[Variable, Default[bool], Global[bool]]] = Field(
+        default=None, validation_alias="echoCanceller", serialization_alias="echoCanceller"
+    )
+    gain: Optional[Union[Variable, Default[int], Global[int]]] = Field(default=None)
+    voice_activity_detection: Optional[Union[Variable, Default[bool], Global[bool]]] = Field(
+        default=None, validation_alias="voiceActivityDetection", serialization_alias="voiceActivityDetection"
+    )
+
+
+OutgoingIeType = Literal[
+    "called-number",
+    "called-subaddr",
+    "caller-number",
+    "caller-subaddr",
+    "connected-number",
+    "connected-subaddr",
+    "display",
+    "extended-facility",
+    "facility",
+    "high-layer-compat",
+    "low-layer-compat",
+    "network-facility",
+    "notify-indicator",
+    "progress-indicator",
+    "redirecting-number",
+    "user-user",
+]
+
+
+class OutgoingIe(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    port_range: Union[Variable, Global[str]] = Field(validation_alias="portRange", serialization_alias="portRange")
+    type: Union[Variable, Global[List[OutgoingIeType]]] = Field()
+
+
+TranslationProfileDirection = Literal[
+    "incoming",
+    "outgoing",
+]
+
+
+class Association(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    port_range: Union[Variable, Global[str]] = Field(validation_alias="portRange", serialization_alias="portRange")
+    translation_profile: Optional[RefIdItem] = Field(
+        default=None, validation_alias="translationProfile", serialization_alias="translationProfile"
+    )
+    translation_profile_direction: Optional[Union[Variable, Default[None], Global[TranslationProfileDirection]]] = (
+        Field(
+            default=Default[None](value=None),
+            validation_alias="translationProfileDirection",
+            serialization_alias="translationProfileDirection",
+        )
+    )
+    trunk_group: Optional[RefIdItem] = Field(
+        default=None, validation_alias="trunkGroup", serialization_alias="trunkGroup"
+    )
+    trunk_group_priority: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=Default[None](value=None),
+        validation_alias="trunkGroupPriority",
+        serialization_alias="trunkGroupPriority",
+    )
+
+
+VALIDATION_DIGITAL_INTERFACE_VIT_E1_BASIC_SETTINGS_REQUIREMENTS = {
+    "line_code": {"ami", "hdb3"},
+    "framing": {"crc4", "no-crc4"},
+    "line_termination": {"120-ohm", "75-ohm"},
+    "framing_australia": {True},
+}
+
+VALIDATION_DIGITAL_INTERFACE_VIT_T1_BASIC_SETTINGS_REQUIREMENTS = {
+    "line_code": {"ami", "b8zs", "hdb3"},
+    "framing": {"esf", "sf"},
+    "cable_length_type": {"long", "short"},
+    "cable_length": {"0", "110", "220", "330", "440", "550", "660", "-7.5", "-15", "-22.5"},
+}
+
+
+def validate_basic_settings_values(basic_settings: List[BasicSettings], check_for: dict, template_type: str):
+    for basic_setting in basic_settings:
+        for key, values in check_for.items():
+            attribute = getattr(basic_setting, key, None)
+            if attribute is None:
+                raise ValueError(
+                    f"For {template_type} configuration, missing value for '{key}'. "
+                    f"Expected one of: {check_for[key]}."
+                )
+            if attribute.option_type == "variable":
+                continue
+            current_value = attribute.value
+            if current_value not in values:
+                raise ValueError(
+                    f"For {template_type} configuration, invalid value '{current_value}' for '{key}'. "
+                    f"Expected one of: {check_for[key]}."
+                )
+
+
+class DigitalInterfaceParcel(_ParcelBase):
+    type_: Literal["digital-interface"] = Field(default="digital-interface", exclude=True)
+    model_config = ConfigDict(populate_by_name=True)
+    basic_settings: List[BasicSettings] = Field(
+        validation_alias=AliasPath("data", "basicSettings"), description="add basic setting"
+    )
+    dsp_hairpin: Union[Variable, Default[bool], Global[bool]] = Field(
+        validation_alias=AliasPath("data", "dspHairpin"),
+    )
+    interface: List[Interface] = Field(
+        validation_alias=AliasPath("data", "interface"), description="Configure Digital voice card interface"
+    )
+    isdn_timer: List[IsdnTimer] = Field(
+        validation_alias=AliasPath("data", "isdnTimer"), description="list of ISDN Timers"
+    )
+    module_location: Union[Variable, Global[ModuleLocation]] = Field(
+        validation_alias=AliasPath("data", "moduleLocation")
+    )
+    shutdown: List[Shutdown] = Field(
+        validation_alias=AliasPath("data", "shutdown"), description="list of shutdown options"
+    )
+    association: Optional[List[Association]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "associations"),
+        description="Select Trunk Group and Translation Profile associations",
+    )
+    isdn_map: Optional[List[IsdnMap]] = Field(
+        default=None, validation_alias=AliasPath("data", "isdnMap"), description="list of ISDN map"
+    )
+    line_params: Optional[List[LineParams]] = Field(
+        default=None, validation_alias=AliasPath("data", "lineParams"), description="list of line parameters"
+    )
+    outgoing_ie: Optional[List[OutgoingIe]] = Field(
+        default=None, validation_alias=AliasPath("data", "outgoingIe"), description="list of outgoing IEs and messages"
+    )
+    voice_interface_templates: Optional[Global[VoiceInterfaceTemplates]] = Field(
+        default=None, validation_alias=AliasPath("data", "voiceInterfaceTemplates")
+    )
+
+    @model_validator(mode="after")
+    def validate(self):
+        if self.voice_interface_templates and "E1" in self.voice_interface_templates.value:
+            check_for = VALIDATION_DIGITAL_INTERFACE_VIT_E1_BASIC_SETTINGS_REQUIREMENTS
+            template_type = "E1"
+        else:
+            check_for = VALIDATION_DIGITAL_INTERFACE_VIT_T1_BASIC_SETTINGS_REQUIREMENTS
+            template_type = "T1"
+
+        validate_basic_settings_values(self.basic_settings, check_for, template_type)
+
+        return self