scm-python 0.1.0__py3-none-any.whl

scm/network_services/models/sdwan_error_correction_profiles_mode_packet_duplication.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SdwanErrorCorrectionProfilesModePacketDuplication(BaseModel):
+    """
+    SdwanErrorCorrectionProfilesModePacketDuplication
+    """ # noqa: E501
+    recovery_duration_pd: StrictInt
+    __properties: ClassVar[List[str]] = ["recovery_duration_pd"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SdwanErrorCorrectionProfilesModePacketDuplication from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SdwanErrorCorrectionProfilesModePacketDuplication from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "recovery_duration_pd": obj.get("recovery_duration_pd")
+        })
+        return _obj
+
+

scm/network_services/models/sdwan_path_quality_profiles.py

@@ -0,0 +1,135 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from scm.network_services.models.sdwan_path_quality_profiles_metric import SdwanPathQualityProfilesMetric
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SdwanPathQualityProfiles(BaseModel):
+    """
+    SdwanPathQualityProfiles
+    """ # noqa: E501
+    device: Optional[Annotated[str, Field(strict=True, max_length=64)]] = Field(default=None, description="The device in which the resource is defined")
+    folder: Optional[Annotated[str, Field(strict=True, max_length=64)]] = Field(default=None, description="The folder in which the resource is defined")
+    id: Optional[StrictStr] = Field(default=None, description="UUID of the resource")
+    metric: SdwanPathQualityProfilesMetric
+    name: Annotated[str, Field(strict=True, max_length=31)] = Field(description="Profile name")
+    snippet: Optional[Annotated[str, Field(strict=True, max_length=64)]] = Field(default=None, description="The snippet in which the resource is defined")
+    __properties: ClassVar[List[str]] = ["device", "folder", "id", "metric", "name", "snippet"]
+
+    @field_validator('device')
+    def device_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z\d\-_\. ]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z\d\-_\. ]+$/")
+        return value
+
+    @field_validator('folder')
+    def folder_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z\d\-_\. ]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z\d\-_\. ]+$/")
+        return value
+
+    @field_validator('snippet')
+    def snippet_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z\d\-_\. ]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z\d\-_\. ]+$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfiles from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of metric
+        if self.metric:
+            _dict['metric'] = self.metric.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfiles from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "device": obj.get("device"),
+            "folder": obj.get("folder"),
+            "id": obj.get("id"),
+            "metric": SdwanPathQualityProfilesMetric.from_dict(obj["metric"]) if obj.get("metric") is not None else None,
+            "name": obj.get("name"),
+            "snippet": obj.get("snippet")
+        })
+        return _obj
+
+

scm/network_services/models/sdwan_path_quality_profiles_list_response.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List
+from scm.network_services.models.sdwan_path_quality_profiles import SdwanPathQualityProfiles
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SDWANPathQualityProfilesListResponse(BaseModel):
+    """
+    SDWANPathQualityProfilesListResponse
+    """ # noqa: E501
+    data: List[SdwanPathQualityProfiles]
+    limit: StrictInt = Field(description="The maximum number of results per page")
+    offset: StrictInt = Field(description="The offset into the list of results returned")
+    total: StrictInt = Field(description="The total count of results")
+    __properties: ClassVar[List[str]] = ["data", "limit", "offset", "total"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SDWANPathQualityProfilesListResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
+        _items = []
+        if self.data:
+            for _item_data in self.data:
+                if _item_data:
+                    _items.append(_item_data.to_dict())
+            _dict['data'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SDWANPathQualityProfilesListResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # Detect bare object response (API returns single object instead of paginated list)
+        # This happens when server-side name filtering returns exactly one result
+        if "data" not in obj and "total" not in obj:
+            single_obj = SdwanPathQualityProfiles.from_dict(obj)
+            return cls.model_validate({
+                "data": [single_obj] if single_obj is not None else [],
+                "limit": 1,
+                "offset": 0,
+                "total": 1 if single_obj is not None else 0,
+            })
+
+        _obj = cls.model_validate({
+            "data": [SdwanPathQualityProfiles.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
+            "limit": obj.get("limit") if obj.get("limit") is not None else 200,
+            "offset": obj.get("offset") if obj.get("offset") is not None else 0,
+            "total": obj.get("total")
+        })
+        return _obj
+
+

scm/network_services/models/sdwan_path_quality_profiles_metric.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from scm.network_services.models.sdwan_path_quality_profiles_metric_jitter import SdwanPathQualityProfilesMetricJitter
+from scm.network_services.models.sdwan_path_quality_profiles_metric_latency import SdwanPathQualityProfilesMetricLatency
+from scm.network_services.models.sdwan_path_quality_profiles_metric_pkt_loss import SdwanPathQualityProfilesMetricPktLoss
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SdwanPathQualityProfilesMetric(BaseModel):
+    """
+    SdwanPathQualityProfilesMetric
+    """ # noqa: E501
+    jitter: SdwanPathQualityProfilesMetricJitter
+    latency: SdwanPathQualityProfilesMetricLatency
+    pkt_loss: Optional[SdwanPathQualityProfilesMetricPktLoss] = None
+    __properties: ClassVar[List[str]] = ["jitter", "latency", "pkt_loss"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetric from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of jitter
+        if self.jitter:
+            _dict['jitter'] = self.jitter.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of latency
+        if self.latency:
+            _dict['latency'] = self.latency.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pkt_loss
+        if self.pkt_loss:
+            _dict['pkt_loss'] = self.pkt_loss.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetric from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jitter": SdwanPathQualityProfilesMetricJitter.from_dict(obj["jitter"]) if obj.get("jitter") is not None else None,
+            "latency": SdwanPathQualityProfilesMetricLatency.from_dict(obj["latency"]) if obj.get("latency") is not None else None,
+            "pkt_loss": SdwanPathQualityProfilesMetricPktLoss.from_dict(obj["pkt_loss"]) if obj.get("pkt_loss") is not None else None
+        })
+        return _obj
+
+

scm/network_services/models/sdwan_path_quality_profiles_metric_jitter.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SdwanPathQualityProfilesMetricJitter(BaseModel):
+    """
+    SdwanPathQualityProfilesMetricJitter
+    """ # noqa: E501
+    sensitivity: StrictStr = Field(description="Jitter sensitivity")
+    threshold: Annotated[int, Field(le=2000, strict=True, ge=10)] = Field(description="Jitter threshold (ms)")
+    __properties: ClassVar[List[str]] = ["sensitivity", "threshold"]
+
+    @field_validator('sensitivity')
+    def sensitivity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['low', 'medium', 'high']):
+            raise ValueError("must be one of enum values ('low', 'medium', 'high')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetricJitter from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetricJitter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sensitivity": obj.get("sensitivity") if obj.get("sensitivity") is not None else 'medium',
+            "threshold": obj.get("threshold") if obj.get("threshold") is not None else 100
+        })
+        return _obj
+
+

scm/network_services/models/sdwan_path_quality_profiles_metric_latency.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Network Services
+
+    These APIs are used for defining and managing network services configuration within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SdwanPathQualityProfilesMetricLatency(BaseModel):
+    """
+    SdwanPathQualityProfilesMetricLatency
+    """ # noqa: E501
+    sensitivity: StrictStr = Field(description="Latency sensitivity")
+    threshold: Annotated[int, Field(le=3000, strict=True, ge=10)] = Field(description="Latency threshold (ms)")
+    __properties: ClassVar[List[str]] = ["sensitivity", "threshold"]
+
+    @field_validator('sensitivity')
+    def sensitivity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['low', 'medium', 'high']):
+            raise ValueError("must be one of enum values ('low', 'medium', 'high')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetricLatency from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SdwanPathQualityProfilesMetricLatency from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sensitivity": obj.get("sensitivity") if obj.get("sensitivity") is not None else 'medium',
+            "threshold": obj.get("threshold") if obj.get("threshold") is not None else 100
+        })
+        return _obj
+
+