pidginhost-sdk 0.2.0__py3-none-any.whl

pidginhost_sdk/models/patched_cluster_detail.py

@@ -0,0 +1,151 @@
+# coding: utf-8
+
+"""
+    Pidgin Host API
+
+    The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.
+
+    The version of the OpenAPI document: 1.0.0 (v1)
+    Contact: support@pidginhost.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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from pidginhost_sdk.models.features_enum import FeaturesEnum
+from pidginhost_sdk.models.status_a57_enum import StatusA57Enum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchedClusterDetail(BaseModel):
+    """
+    PatchedClusterDetail
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    status: Optional[StatusA57Enum] = None
+    name: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None
+    cluster_type: Optional[StrictStr] = None
+    kube_version: Optional[StrictStr] = None
+    price_per_month: Optional[Annotated[str, Field(strict=True)]] = None
+    price_per_hour: Optional[StrictStr] = None
+    features: Optional[List[FeaturesEnum]] = None
+    features_ready: Optional[StrictBool] = None
+    kubeconfig_valid_until: Optional[StrictStr] = None
+    ipv4_address: Optional[StrictStr] = None
+    protected: Optional[StrictBool] = None
+    talos_version: Optional[StrictStr] = None
+    talos_upgrade_available: Optional[StrictStr] = None
+    talos_next_version: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["id", "status", "name", "cluster_type", "kube_version", "price_per_month", "price_per_hour", "features", "features_ready", "kubeconfig_valid_until", "ipv4_address", "protected", "talos_version", "talos_upgrade_available", "talos_next_version"]
+
+    @field_validator('price_per_month')
+    def price_per_month_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^-?\d{0,16}(?:\.\d{0,4})?$", value):
+            raise ValueError(r"must validate the regular expression /^-?\d{0,16}(?:\.\d{0,4})?$/")
+        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 PatchedClusterDetail 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "status",
+            "cluster_type",
+            "kube_version",
+            "price_per_hour",
+            "features_ready",
+            "kubeconfig_valid_until",
+            "ipv4_address",
+            "talos_version",
+            "talos_upgrade_available",
+            "talos_next_version",
+        ])
+
+        _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 PatchedClusterDetail from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "status": obj.get("status"),
+            "name": obj.get("name"),
+            "cluster_type": obj.get("cluster_type"),
+            "kube_version": obj.get("kube_version"),
+            "price_per_month": obj.get("price_per_month"),
+            "price_per_hour": obj.get("price_per_hour"),
+            "features": obj.get("features"),
+            "features_ready": obj.get("features_ready"),
+            "kubeconfig_valid_until": obj.get("kubeconfig_valid_until"),
+            "ipv4_address": obj.get("ipv4_address"),
+            "protected": obj.get("protected"),
+            "talos_version": obj.get("talos_version"),
+            "talos_upgrade_available": obj.get("talos_upgrade_available"),
+            "talos_next_version": obj.get("talos_next_version")
+        })
+        return _obj
+
+

pidginhost_sdk/models/patched_company.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Pidgin Host API
+
+    The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.
+
+    The version of the OpenAPI document: 1.0.0 (v1)
+    Contact: support@pidginhost.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, Optional
+from typing_extensions import Annotated
+from pidginhost_sdk.models.address import Address
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchedCompany(BaseModel):
+    """
+    PatchedCompany
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    name: Optional[Annotated[str, Field(strict=True, max_length=200)]] = None
+    cif_vat: Optional[Annotated[str, Field(strict=True, max_length=50)]] = None
+    reg: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    iban: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    bank: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    contact_name: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    contact_email: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    address: Optional[Address] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "cif_vat", "reg", "iban", "bank", "contact_name", "contact_email", "address"]
+
+    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 PatchedCompany 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 address
+        if self.address:
+            _dict['address'] = self.address.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PatchedCompany from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "cif_vat": obj.get("cif_vat"),
+            "reg": obj.get("reg"),
+            "iban": obj.get("iban"),
+            "bank": obj.get("bank"),
+            "contact_name": obj.get("contact_name"),
+            "contact_email": obj.get("contact_email"),
+            "address": Address.from_dict(obj["address"]) if obj.get("address") is not None else None
+        })
+        return _obj
+
+

pidginhost_sdk/models/patched_domain.py

@@ -0,0 +1,152 @@
+# coding: utf-8
+
+"""
+    Pidgin Host API
+
+    The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.
+
+    The version of the OpenAPI document: 1.0.0 (v1)
+    Contact: support@pidginhost.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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from pidginhost_sdk.models.service import Service
+from pidginhost_sdk.models.tld import TLD
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchedDomain(BaseModel):
+    """
+    PatchedDomain
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    domain: Optional[StrictStr] = None
+    tld: Optional[TLD] = None
+    idna: Optional[StrictBool] = Field(default=None, description="Domain name is encoded with IDN")
+    nameservers: Optional[Annotated[str, Field(strict=True, max_length=1200)]] = Field(default=None, description="List of 2-5 name-servers separated by comma.")
+    expiration_date: Optional[date] = None
+    registration_date: Optional[date] = None
+    service: Optional[Service] = None
+    idna_name: Optional[StrictStr] = None
+    max_renew_years: Optional[StrictInt] = None
+    service_status: Optional[StrictStr] = Field(default=None, description="Service status")
+    contacts: Optional[Any] = None
+    __properties: ClassVar[List[str]] = ["id", "domain", "tld", "idna", "nameservers", "expiration_date", "registration_date", "service", "idna_name", "max_renew_years", "service_status", "contacts"]
+
+    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 PatchedDomain 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "domain",
+            "tld",
+            "idna",
+            "expiration_date",
+            "registration_date",
+            "service",
+            "idna_name",
+            "max_renew_years",
+            "service_status",
+            "contacts",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of tld
+        if self.tld:
+            _dict['tld'] = self.tld.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of service
+        if self.service:
+            _dict['service'] = self.service.to_dict()
+        # set to None if registration_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.registration_date is None and "registration_date" in self.model_fields_set:
+            _dict['registration_date'] = None
+
+        # set to None if contacts (nullable) is None
+        # and model_fields_set contains the field
+        if self.contacts is None and "contacts" in self.model_fields_set:
+            _dict['contacts'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PatchedDomain from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "domain": obj.get("domain"),
+            "tld": TLD.from_dict(obj["tld"]) if obj.get("tld") is not None else None,
+            "idna": obj.get("idna"),
+            "nameservers": obj.get("nameservers"),
+            "expiration_date": obj.get("expiration_date"),
+            "registration_date": obj.get("registration_date"),
+            "service": Service.from_dict(obj["service"]) if obj.get("service") is not None else None,
+            "idna_name": obj.get("idna_name"),
+            "max_renew_years": obj.get("max_renew_years"),
+            "service_status": obj.get("service_status"),
+            "contacts": obj.get("contacts")
+        })
+        return _obj
+
+

pidginhost_sdk/models/patched_domain_registrant.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+"""
+    Pidgin Host API
+
+    The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.
+
+    The version of the OpenAPI document: 1.0.0 (v1)
+    Contact: support@pidginhost.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, Optional
+from typing_extensions import Annotated
+from pidginhost_sdk.models.country_enum import CountryEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchedDomainRegistrant(BaseModel):
+    """
+    PatchedDomainRegistrant
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    first_name: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    last_name: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    company: Optional[Annotated[str, Field(strict=True, max_length=40)]] = None
+    address: Optional[Annotated[str, Field(strict=True, max_length=128)]] = None
+    city: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    region: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    postal_code: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    country: Optional[CountryEnum] = None
+    email: Optional[Annotated[str, Field(strict=True, max_length=128)]] = None
+    phone: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    cif_cnp: Optional[Annotated[str, Field(strict=True, max_length=40)]] = None
+    reg_com: Optional[Annotated[str, Field(strict=True, max_length=40)]] = None
+    __properties: ClassVar[List[str]] = ["id", "first_name", "last_name", "company", "address", "city", "region", "postal_code", "country", "email", "phone", "cif_cnp", "reg_com"]
+
+    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 PatchedDomainRegistrant 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,
+        )
+        # set to None if company (nullable) is None
+        # and model_fields_set contains the field
+        if self.company is None and "company" in self.model_fields_set:
+            _dict['company'] = None
+
+        # set to None if cif_cnp (nullable) is None
+        # and model_fields_set contains the field
+        if self.cif_cnp is None and "cif_cnp" in self.model_fields_set:
+            _dict['cif_cnp'] = None
+
+        # set to None if reg_com (nullable) is None
+        # and model_fields_set contains the field
+        if self.reg_com is None and "reg_com" in self.model_fields_set:
+            _dict['reg_com'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PatchedDomainRegistrant from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "first_name": obj.get("first_name"),
+            "last_name": obj.get("last_name"),
+            "company": obj.get("company"),
+            "address": obj.get("address"),
+            "city": obj.get("city"),
+            "region": obj.get("region"),
+            "postal_code": obj.get("postal_code"),
+            "country": obj.get("country"),
+            "email": obj.get("email"),
+            "phone": obj.get("phone"),
+            "cif_cnp": obj.get("cif_cnp"),
+            "reg_com": obj.get("reg_com")
+        })
+        return _obj
+
+

pidginhost_sdk/models/patched_firewall_rule.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+    Pidgin Host API
+
+    The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.
+
+    The version of the OpenAPI document: 1.0.0 (v1)
+    Contact: support@pidginhost.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from pidginhost_sdk.models.firewall_rule_direction_enum import FirewallRuleDirectionEnum
+from pidginhost_sdk.models.fw_policy_out_enum import FwPolicyOutEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchedFirewallRule(BaseModel):
+    """
+    PatchedFirewallRule
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    direction: Optional[FirewallRuleDirectionEnum] = None
+    action: Optional[FwPolicyOutEnum] = None
+    protocol: Optional[Annotated[str, Field(strict=True, max_length=100)]] = None
+    source: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="single IP, range (20.34.101.207-201.3.9.99) or comma separated list")
+    sport: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="numbers (0-65535), range (\"\\d+:\\d+\", like \"80:85\"), comma separated list")
+    destination: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="single IP, range (20.34.101.207-201.3.9.99) or comma separated list")
+    dport: Optional[Annotated[str, Field(strict=True, max_length=500)]] = Field(default=None, description="numbers (0-65535), range (\"\\d+:\\d+\", like \"80:85\"), comma separated list")
+    enabled: Optional[StrictBool] = None
+    position: Optional[Annotated[int, Field(le=32767, strict=True, ge=0)]] = None
+    has_error: Optional[StrictBool] = None
+    error_message: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["id", "direction", "action", "protocol", "source", "sport", "destination", "dport", "enabled", "position", "has_error", "error_message"]
+
+    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 PatchedFirewallRule 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "has_error",
+            "error_message",
+        ])
+
+        _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 PatchedFirewallRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "direction": obj.get("direction"),
+            "action": obj.get("action"),
+            "protocol": obj.get("protocol"),
+            "source": obj.get("source"),
+            "sport": obj.get("sport"),
+            "destination": obj.get("destination"),
+            "dport": obj.get("dport"),
+            "enabled": obj.get("enabled"),
+            "position": obj.get("position"),
+            "has_error": obj.get("has_error"),
+            "error_message": obj.get("error_message")
+        })
+        return _obj
+
+