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

catalystwan/models/policy/definition/cflowd.py

@@ -0,0 +1,95 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.common import VpnId
+from catalystwan.models.policy.policy_definition import (
+    Optimized,
+    PolicyDefinitionBase,
+    PolicyDefinitionGetResponse,
+    PolicyDefinitionId,
+)
+
+IpProtocol = Literal["ipv4", "ipv6", "both"]
+TransportProtocol = Literal["transport_udp", "transport_tcp"]
+ExportState = Literal["enable"]
+
+
+class Collector(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    vpn: VpnId
+    address: str
+    port: int = Field(ge=1024, le=65536)
+    transport: TransportProtocol
+    source_interface: Optional[str] = Field(
+        default=None, validation_alias="sourceInterface", serialization_alias="sourceInterface"
+    )
+    export_spread: Optional[ExportState] = Field(
+        default=None, validation_alias="exportSpread", serialization_alias="exportSpread"
+    )
+    bfd_metrics_export: Optional[ExportState] = Field(
+        default=None, validation_alias="bfd-metrics-export", serialization_alias="bfd-metrics-export"
+    )
+    export_interval: Optional[int] = Field(
+        default=None, validation_alias="export-interval", serialization_alias="export-interval", ge=0, le=86400
+    )
+
+    def enable_bfd_metrics_exporting(self, export_interval: int):
+        self.bfd_metrics_export = "enable"
+        self.export_interval = export_interval
+
+
+class CustomizedIpv4RecordFields(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    collect_tos: bool = Field(default=False, validation_alias="collectTos", serialization_alias="collectTos")
+    collect_dscp_output: bool = Field(
+        default=False, validation_alias="collectDscpOutput", serialization_alias="collectDscpOutput"
+    )
+
+
+class CflowdDefinition(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    collectors: List[Collector] = []
+    protocol: IpProtocol = "ipv4"
+
+    flow_active_timeout: Optional[int] = Field(
+        default=None, validation_alias="flowActiveTimeout", serialization_alias="flowActiveTimeout", ge=30, le=3600
+    )
+
+    flow_inactive_timeout: Optional[int] = Field(
+        default=None, validation_alias="flowInactiveTimeout", serialization_alias="flowInactiveTimeout", ge=1, le=3600
+    )
+
+    template_refresh: Optional[int] = Field(
+        default=None, validation_alias="templateRefresh", serialization_alias="templateRefresh", ge=60, le=86400
+    )
+
+    flow_sampling_interval: Optional[int] = Field(
+        default=None,
+        validation_alias="flowSamplingInterval",
+        serialization_alias="flowSamplingInterval",
+        ge=1,
+        le=65536,
+    )
+
+    customized_ipv4_record_fields: CustomizedIpv4RecordFields = Field(
+        default=CustomizedIpv4RecordFields(),
+        validation_alias="customizedIpv4RecordFields",
+        serialization_alias="customizedIpv4RecordFields",
+    )
+
+
+class CflowdPolicy(PolicyDefinitionBase):
+    type: Literal["cflowd"] = "cflowd"
+    optimized: Optional[Optimized] = None
+    definition: CflowdDefinition
+
+
+class CflowdPolicyEditPayload(CflowdPolicy, PolicyDefinitionId):
+    pass
+
+
+class CflowdPolicyGetResponse(CflowdPolicy, PolicyDefinitionGetResponse):
+    pass

catalystwan/models/policy/{definitions → definition}/control.py

@@ -1,38 +1,40 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
 from ipaddress import IPv4Address
-from typing import Any, List, Literal, Optional, Union, overload
+from typing import List, Literal, Optional, Union, overload
 from uuid import UUID
 
 from pydantic import ConfigDict, Field
 from typing_extensions import Annotated
 
-from catalystwan.models.common import TLOCColor
-from catalystwan.models.policy.lists_entries import EncapType
+from catalystwan.models.common import AcceptRejectActionType, EncapType, SequenceIpType, TLOCColor
 from catalystwan.models.policy.policy_definition import (
+    ActionSet,
     AffinityEntry,
-    Carrier,
     CarrierEntry,
+    CarrierType,
     ColorListEntry,
     CommunityAdditiveEntry,
     CommunityEntry,
     CommunityListEntry,
-    DefaultAction,
+    ControlPathType,
     DefinitionWithSequencesCommonBase,
     DomainIDEntry,
     ExpandedCommunityListEntry,
     ExportToAction,
     GroupIDEntry,
+    Ipv6PrefixListEntry,
     Match,
     MultiRegionRole,
     OMPTagEntry,
     OriginatorEntry,
     OriginEntry,
     OriginProtocol,
-    PathType,
     PathTypeEntry,
-    PolicyActionType,
+    PolicyAcceptRejectAction,
     PolicyDefinitionBase,
+    PolicyDefinitionGetResponse,
+    PolicyDefinitionId,
     PolicyDefinitionSequenceBase,
     PreferenceEntry,
     PrefixListEntry,
@@ -49,6 +51,7 @@ from catalystwan.models.policy.policy_definition import (
     TLOCEntry,
     TLOCEntryValue,
     TLOCListEntry,
+    VPNEntry,
     VPNListEntry,
     accept_action,
 )
@@ -58,6 +61,7 @@ AnyControlPolicyRouteSequenceMatchEntry = Annotated[
         ColorListEntry,
         CommunityListEntry,
         ExpandedCommunityListEntry,
+        Ipv6PrefixListEntry,
         OMPTagEntry,
         OriginatorEntry,
         OriginEntry,
@@ -73,6 +77,7 @@ AnyControlPolicyRouteSequenceMatchEntry = Annotated[
         TLOCEntry,
         TLOCListEntry,
         VPNListEntry,
+        VPNEntry,
     ],
     Field(discriminator="field"),
 ]
@@ -99,8 +104,14 @@ AnyControlPolicyTLOCSequenceMatchEntry = Annotated[
     Field(discriminator="field"),
 ]
 
-ControlPolicyRouteSequenceActions = Any  # TODO
-ControlPolicyTLOCSequenceActions = Any  # TODO
+ControlPolicyRouteSequenceActions = Annotated[
+    Union[
+        ActionSet,
+        ExportToAction,
+    ],
+    Field(discriminator="type"),
+]
+ControlPolicyTLOCSequenceActions = ActionSet
 
 
 class ControlPolicyHeader(PolicyDefinitionBase):
@@ -108,7 +119,7 @@ class ControlPolicyHeader(PolicyDefinitionBase):
 
 
 class ControlPolicyRouteSequenceMatch(Match):
-    entries: List[AnyControlPolicyRouteSequenceMatchEntry] = []
+    entries: List[AnyControlPolicyRouteSequenceMatchEntry] = Field(default_factory=list)
 
 
 class ControlPolicyTLOCSequenceMatch(Match):
@@ -119,7 +130,7 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
     sequence_type: Literal["route"] = Field(
         default="route", serialization_alias="sequenceType", validation_alias="sequenceType"
     )
-    base_action: PolicyActionType = Field(
+    base_action: AcceptRejectActionType = Field(
         default="reject", serialization_alias="baseAction", validation_alias="baseAction"
     )
     match: ControlPolicyRouteSequenceMatch = ControlPolicyRouteSequenceMatch()
@@ -136,7 +147,7 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
         self._insert_match(ExpandedCommunityListEntry(ref=expanded_community_list_id))
 
     def match_omp_tag(self, omp_tag: int) -> None:
-        self._insert_match(OMPTagEntry(value=str(omp_tag)))
+        self._insert_match(OMPTagEntry(value=omp_tag))
 
     def match_origin(self, origin: OriginProtocol) -> None:
         self._insert_match(OriginEntry(value=origin))
@@ -144,7 +155,7 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
     def match_originator(self, originator: IPv4Address) -> None:
         self._insert_match(OriginatorEntry(value=originator))
 
-    def match_path_type(self, path_type: PathType) -> None:
+    def match_path_type(self, path_type: ControlPathType) -> None:
         self._insert_match(PathTypeEntry(value=path_type))
 
     def match_preference(self, preference: int) -> None:
@@ -182,6 +193,9 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
     def match_prefix_list(self, prefix_list_id: UUID) -> None:
         self._insert_match(PrefixListEntry(ref=prefix_list_id))
 
+    def match_ipv6_prefix_list(self, prefix_list_id: UUID) -> None:
+        self._insert_match(Ipv6PrefixListEntry(ref=prefix_list_id))
+
     @accept_action
     def associate_community_action(self, community: str, additive: bool = False) -> None:
         self._insert_action_in_set(CommunityEntry(value=community))
@@ -192,7 +206,7 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
 
     @accept_action
     def associate_omp_tag_action(self, omp_tag: int) -> None:
-        self._insert_action_in_set(OMPTagEntry(value=str(omp_tag)))
+        self._insert_action_in_set(OMPTagEntry(value=omp_tag))
 
     @accept_action
     def associate_preference_action(self, preference: int) -> None:
@@ -218,7 +232,7 @@ class ControlPolicyRouteSequence(PolicyDefinitionSequenceBase):
         else:
             tloc_entry = None
             tloc_list_entry = TLOCListEntry(ref=tloc_list_id)
-        service_value = ServiceEntryValue(type=service_type, vpn=str(vpn), tloc=tloc_entry, tloc_list=tloc_list_entry)
+        service_value = ServiceEntryValue(type=service_type, vpn=vpn, tloc=tloc_entry, tloc_list=tloc_list_entry)
         self._insert_action_in_set(ServiceEntry(value=service_value))
 
     @accept_action
@@ -238,14 +252,14 @@ class ControlPolicyTLOCSequence(PolicyDefinitionSequenceBase):
     sequence_type: Literal["tloc"] = Field(
         default="tloc", serialization_alias="sequenceType", validation_alias="sequenceType"
     )
-    base_action: PolicyActionType = Field(
+    base_action: AcceptRejectActionType = Field(
         default="reject", serialization_alias="baseAction", validation_alias="baseAction"
     )
     match: ControlPolicyTLOCSequenceMatch = ControlPolicyTLOCSequenceMatch()
     actions: List[ControlPolicyTLOCSequenceActions] = []
     model_config = ConfigDict(populate_by_name=True)
 
-    def match_carrier(self, carrier: Carrier) -> None:
+    def match_carrier(self, carrier: CarrierType) -> None:
         self._insert_match(CarrierEntry(value=carrier))
 
     def match_color_list(self, color_list_id: UUID) -> None:
@@ -258,7 +272,7 @@ class ControlPolicyTLOCSequence(PolicyDefinitionSequenceBase):
         self._insert_match(GroupIDEntry(value=str(group_id)))
 
     def match_omp_tag(self, omp_tag: int) -> None:
-        self._insert_match(OMPTagEntry(value=str(omp_tag)))
+        self._insert_match(OMPTagEntry(value=omp_tag))
 
     def match_originator(self, originator: IPv4Address) -> None:
         self._insert_match(OriginatorEntry(value=originator))
@@ -294,7 +308,7 @@ class ControlPolicyTLOCSequence(PolicyDefinitionSequenceBase):
 
     @accept_action
     def associate_omp_tag_action(self, omp_tag: int) -> None:
-        self._insert_action_in_set(OMPTagEntry(value=str(omp_tag)))
+        self._insert_action_in_set(OMPTagEntry(value=omp_tag))
 
     @accept_action
     def associate_preference_action(self, preference: int) -> None:
@@ -312,32 +326,41 @@ AnyControlPolicySequence = Annotated[
 
 
 class ControlPolicy(ControlPolicyHeader, DefinitionWithSequencesCommonBase):
+    type: Literal["control"] = "control"
     sequences: List[AnyControlPolicySequence] = []
-    default_action: DefaultAction = Field(
-        default=DefaultAction(type="reject"),
+    default_action: PolicyAcceptRejectAction = Field(
+        default=PolicyAcceptRejectAction(type="reject"),
         serialization_alias="defaultAction",
         validation_alias="defaultAction",
     )
     model_config = ConfigDict(populate_by_name=True)
 
     def add_route_sequence(
-        self, name: str = "Route", base_action: PolicyActionType = "reject"
+        self, name: str = "Route", base_action: AcceptRejectActionType = "reject", ip_type: SequenceIpType = "ipv4"
     ) -> ControlPolicyRouteSequence:
         seq = ControlPolicyRouteSequence(
             sequence_name=name,
             base_action=base_action,
-            sequence_ip_type="ipv4",
+            sequence_ip_type=ip_type,
         )
         self.add(seq)
         return seq
 
     def add_tloc_sequence(
-        self, name: str = "TLOC", base_action: PolicyActionType = "reject"
+        self, name: str = "TLOC", base_action: AcceptRejectActionType = "reject", ip_type: SequenceIpType = "ipv4"
     ) -> ControlPolicyTLOCSequence:
         seq = ControlPolicyTLOCSequence(
             sequence_name=name,
             base_action=base_action,
-            sequence_ip_type="ipv4",
+            sequence_ip_type=ip_type,
         )
         self.add(seq)
         return seq
+
+
+class ControlPolicyEditPayload(ControlPolicy, PolicyDefinitionId):
+    pass
+
+
+class ControlPolicyGetResponse(ControlPolicy, PolicyDefinitionGetResponse):
+    pass

catalystwan/models/policy/{definitions → definition}/device_access.py

@@ -7,21 +7,23 @@ from uuid import UUID
 from pydantic import ConfigDict, Field
 from typing_extensions import Annotated
 
+from catalystwan.models.common import AcceptDropActionType, DeviceAccessProtocolPort
 from catalystwan.models.policy.policy_definition import (
     CountAction,
-    DefaultAction,
     DefinitionWithSequencesCommonBase,
     DestinationDataPrefixListEntry,
     DestinationIPEntry,
     DestinationPortEntry,
-    DeviceAccessProtocol,
     Match,
-    PolicyActionType,
+    PolicyAcceptDropAction,
     PolicyDefinitionBase,
+    PolicyDefinitionGetResponse,
+    PolicyDefinitionId,
     PolicyDefinitionSequenceBase,
     SourceDataPrefixListEntry,
     SourceIPEntry,
     SourcePortEntry,
+    VPNEntry,
 )
 
 DeviceAccessPolicySequenceMatchEntry = Annotated[
@@ -32,6 +34,7 @@ DeviceAccessPolicySequenceMatchEntry = Annotated[
         SourceDataPrefixListEntry,
         SourceIPEntry,
         SourcePortEntry,
+        VPNEntry,
     ],
     Field(discriminator="field"),
 ]
@@ -51,18 +54,18 @@ class DeviceAccessPolicySequence(PolicyDefinitionSequenceBase):
     sequence_type: Literal["deviceaccesspolicy"] = Field(
         default="deviceaccesspolicy", serialization_alias="sequenceType", validation_alias="sequenceType"
     )
-    base_action: PolicyActionType = Field(
+    base_action: AcceptDropActionType = Field(
         default="accept", serialization_alias="baseAction", validation_alias="baseAction"
     )
     match: DeviceAccessPolicySequenceMatch = DeviceAccessPolicySequenceMatch()
     actions: List[DeviceAccessPolicySequenceActions] = []
     model_config = ConfigDict(populate_by_name=True)
 
-    def match_device_access_protocol(self, port: DeviceAccessProtocol) -> None:
+    def match_device_access_protocol(self, port: DeviceAccessProtocolPort) -> None:
         self._insert_match(DestinationPortEntry.from_port_set_and_ranges(ports={port}))
 
     def match_source_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(SourceDataPrefixListEntry(ref=data_prefix_list_id))
+        self._insert_match(SourceDataPrefixListEntry(ref=[data_prefix_list_id]))
 
     def match_source_ip(self, networks: List[IPv4Network]) -> None:
         self._insert_match(SourceIPEntry.from_ipv4_networks(networks))
@@ -71,7 +74,7 @@ class DeviceAccessPolicySequence(PolicyDefinitionSequenceBase):
         self._insert_match(SourcePortEntry.from_port_set_and_ranges(ports, port_ranges))
 
     def match_destination_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(DestinationDataPrefixListEntry(ref=data_prefix_list_id))
+        self._insert_match(DestinationDataPrefixListEntry(ref=[data_prefix_list_id]))
 
     def match_destination_ip(self, networks: List[IPv4Network]) -> None:
         self._insert_match(DestinationIPEntry.from_ipv4_networks(networks))
@@ -82,8 +85,8 @@ class DeviceAccessPolicySequence(PolicyDefinitionSequenceBase):
 
 class DeviceAccessPolicy(DeviceAccessPolicyHeader, DefinitionWithSequencesCommonBase):
     sequences: List[DeviceAccessPolicySequence] = []
-    default_action: DefaultAction = Field(
-        default=DefaultAction(type="drop"),
+    default_action: PolicyAcceptDropAction = Field(
+        default=PolicyAcceptDropAction(type="drop"),
         serialization_alias="defaultAction",
         validation_alias="defaultAction",
     )
@@ -92,8 +95,8 @@ class DeviceAccessPolicy(DeviceAccessPolicyHeader, DefinitionWithSequencesCommon
     def add_acl_sequence(
         self,
         name: str = "Device Access Control List",
-        base_action: PolicyActionType = "accept",
-        device_access_protocol: Optional[DeviceAccessProtocol] = None,
+        base_action: AcceptDropActionType = "accept",
+        device_access_protocol: Optional[DeviceAccessProtocolPort] = None,
     ) -> DeviceAccessPolicySequence:
         seq = DeviceAccessPolicySequence(
             sequence_name=name,
@@ -104,3 +107,11 @@ class DeviceAccessPolicy(DeviceAccessPolicyHeader, DefinitionWithSequencesCommon
             seq.match_device_access_protocol(port=device_access_protocol)
         self.add(seq)
         return seq
+
+
+class DeviceAccessPolicyEditPayload(DeviceAccessPolicy, PolicyDefinitionId):
+    pass
+
+
+class DeviceAccessPolicyGetResponse(DeviceAccessPolicy, PolicyDefinitionGetResponse):
+    pass

catalystwan/models/policy/{definitions → definition}/device_access_ipv6.py

@@ -7,17 +7,18 @@ from uuid import UUID
 from pydantic import ConfigDict, Field
 from typing_extensions import Annotated
 
+from catalystwan.models.common import AcceptDropActionType, DeviceAccessProtocolPort
 from catalystwan.models.policy.policy_definition import (
     CountAction,
-    DefaultAction,
     DefinitionWithSequencesCommonBase,
     DestinationDataIPv6PrefixListEntry,
     DestinationIPv6Entry,
     DestinationPortEntry,
-    DeviceAccessProtocol,
     Match,
-    PolicyActionType,
+    PolicyAcceptDropAction,
     PolicyDefinitionBase,
+    PolicyDefinitionGetResponse,
+    PolicyDefinitionId,
     PolicyDefinitionSequenceBase,
     SourceDataIPv6PrefixListEntry,
     SourceIPv6Entry,
@@ -51,18 +52,18 @@ class DeviceAccessIPv6PolicySequence(PolicyDefinitionSequenceBase):
     sequence_type: Literal["deviceaccesspolicyv6"] = Field(
         default="deviceaccesspolicyv6", serialization_alias="sequenceType", validation_alias="sequenceType"
     )
-    base_action: PolicyActionType = Field(
+    base_action: AcceptDropActionType = Field(
         default="accept", serialization_alias="baseAction", validation_alias="baseAction"
     )
     match: DeviceAccessIPv6PolicySequenceMatch = DeviceAccessIPv6PolicySequenceMatch()
     actions: List[DeviceAccessIPv6PolicySequenceActions] = []
     model_config = ConfigDict(populate_by_name=True)
 
-    def match_device_access_protocol(self, port: DeviceAccessProtocol) -> None:
+    def match_device_access_protocol(self, port: DeviceAccessProtocolPort) -> None:
         self._insert_match(DestinationPortEntry.from_port_set_and_ranges(ports={port}))
 
     def match_source_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(SourceDataIPv6PrefixListEntry(ref=data_prefix_list_id))
+        self._insert_match(SourceDataIPv6PrefixListEntry(ref=[data_prefix_list_id]))
 
     def match_source_ip(self, networks: List[IPv6Network]) -> None:
         self._insert_match(SourceIPv6Entry.from_ipv6_networks(networks))
@@ -71,7 +72,7 @@ class DeviceAccessIPv6PolicySequence(PolicyDefinitionSequenceBase):
         self._insert_match(SourcePortEntry.from_port_set_and_ranges(ports, port_ranges))
 
     def match_destination_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(DestinationDataIPv6PrefixListEntry(ref=data_prefix_list_id))
+        self._insert_match(DestinationDataIPv6PrefixListEntry(ref=[data_prefix_list_id]))
 
     def match_destination_ip(self, networks: List[IPv6Network]) -> None:
         self._insert_match(DestinationIPv6Entry.from_ipv6_networks(networks))
@@ -82,8 +83,8 @@ class DeviceAccessIPv6PolicySequence(PolicyDefinitionSequenceBase):
 
 class DeviceAccessIPv6Policy(DeviceAccessIPv6PolicyHeader, DefinitionWithSequencesCommonBase):
     sequences: List[DeviceAccessIPv6PolicySequence] = []
-    default_action: DefaultAction = Field(
-        default=DefaultAction(type="drop"),
+    default_action: PolicyAcceptDropAction = Field(
+        default=PolicyAcceptDropAction(type="drop"),
         serialization_alias="defaultAction",
         validation_alias="defaultAction",
     )
@@ -92,8 +93,8 @@ class DeviceAccessIPv6Policy(DeviceAccessIPv6PolicyHeader, DefinitionWithSequenc
     def add_acl_sequence(
         self,
         name: str = "Device Access Control List",
-        base_action: PolicyActionType = "accept",
-        device_access_protocol: Optional[DeviceAccessProtocol] = None,
+        base_action: AcceptDropActionType = "accept",
+        device_access_protocol: Optional[DeviceAccessProtocolPort] = None,
     ) -> DeviceAccessIPv6PolicySequence:
         seq = DeviceAccessIPv6PolicySequence(
             sequence_name=name,
@@ -104,3 +105,11 @@ class DeviceAccessIPv6Policy(DeviceAccessIPv6PolicyHeader, DefinitionWithSequenc
             seq.match_device_access_protocol(port=device_access_protocol)
         self.add(seq)
         return seq
+
+
+class DeviceAccessIPv6PolicyEditPayload(DeviceAccessIPv6Policy, PolicyDefinitionId):
+    pass
+
+
+class DeviceAccessIPv6PolicyGetResponse(DeviceAccessIPv6Policy, PolicyDefinitionGetResponse):
+    pass

catalystwan/models/policy/definition/dial_peer.py

@@ -0,0 +1,60 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_definition import (
+    MediaProfileRef,
+    PolicyDefinitionBase,
+    PolicyDefinitionGetResponse,
+    PolicyDefinitionId,
+    TranslationProfileEntry,
+    TrunkGroupPreference,
+    VoicePortType,
+)
+
+
+class DialPeerType(BaseModel):
+    type: Literal["pots", "sip"]
+
+
+class DialPeerPolicyDefinition(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    dial_peer_type: DialPeerType = Field(serialization_alias="dialPeerType", validation_alias="dialPeerType")
+    media_profile: Optional[MediaProfileRef] = Field(
+        default=None, serialization_alias="mediaProfile", validation_alias="mediaProfile"
+    )
+    modem_passthrough: Optional[UUID] = Field(
+        default=None, serialization_alias="modemPassthrough", validation_alias="modemPassthrough"
+    )
+    fax_protocol: Optional[UUID] = Field(
+        default=None, serialization_alias="faxProtocol", validation_alias="faxProtocol"
+    )
+    trunk_group: Optional[List[TrunkGroupPreference]] = Field(
+        default=None, serialization_alias="trunkGroup", validation_alias="trunkGroup"
+    )
+    incoming_translation_profile: Optional[TranslationProfileEntry] = Field(
+        default=None, serialization_alias="incomingTranslationProfile", validation_alias="incomingTranslationProfile"
+    )
+    outgoing_translation_profile: Optional[TranslationProfileEntry] = Field(
+        default=None, serialization_alias="outgoingTranslationProfile", validation_alias="outgoingTranslationProfile"
+    )
+
+
+class DialPeerPolicy(PolicyDefinitionBase):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["dialPeer", "dialpeer"] = "dialPeer"
+    port_type: Optional[VoicePortType] = Field(
+        default="potsDialPeer", serialization_alias="portType", validation_alias="portType"
+    )
+    definition: DialPeerPolicyDefinition
+
+
+class DialPeerPolicyEditPayload(DialPeerPolicy, PolicyDefinitionId):
+    pass
+
+
+class DialPeerPolicyGetResponse(DialPeerPolicy, PolicyDefinitionGetResponse):
+    pass