pidginhost-sdk 0.2.0__py3-none-any.whl

pidginhost_sdk/models/detach_ipv6_response.py

@@ -0,0 +1,88 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DetachIPv6Response(BaseModel):
+    """
+    DetachIPv6Response
+    """ # noqa: E501
+    detached: StrictBool
+    __properties: ClassVar[List[str]] = ["detached"]
+
+    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 DetachIPv6Response 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 DetachIPv6Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detached": obj.get("detached")
+        })
+        return _obj
+
+

pidginhost_sdk/models/detach_volume.py

@@ -0,0 +1,88 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DetachVolume(BaseModel):
+    """
+    DetachVolume
+    """ # noqa: E501
+    detached: StrictBool
+    __properties: ClassVar[List[str]] = ["detached"]
+
+    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 DetachVolume 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 DetachVolume from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detached": obj.get("detached")
+        })
+        return _obj
+
+

pidginhost_sdk/models/disconnect_vm_request.py

@@ -0,0 +1,88 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DisconnectVMRequest(BaseModel):
+    """
+    DisconnectVMRequest
+    """ # noqa: E501
+    server: StrictInt = Field(description="VM resource PK")
+    __properties: ClassVar[List[str]] = ["server"]
+
+    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 DisconnectVMRequest 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 DisconnectVMRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "server": obj.get("server")
+        })
+        return _obj
+
+

pidginhost_sdk/models/disconnect_vm_response.py

@@ -0,0 +1,90 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DisconnectVMResponse(BaseModel):
+    """
+    DisconnectVMResponse
+    """ # noqa: E501
+    status: StrictStr
+    message: StrictStr
+    __properties: ClassVar[List[str]] = ["status", "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 DisconnectVMResponse 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 DisconnectVMResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

pidginhost_sdk/models/dns_record.py

@@ -0,0 +1,154 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DNSRecord(BaseModel):
+    """
+    Read-only representation of a DNS record from the cPanel zone dump.
+    """ # noqa: E501
+    line: StrictInt = Field(alias="Line")
+    name: StrictStr
+    ttl: StrictInt
+    type: StrictStr
+    address: StrictStr
+    cname: StrictStr
+    exchange: StrictStr
+    preference: StrictInt
+    txtdata: StrictStr
+    unencoded: StrictStr
+    target: StrictStr
+    priority: StrictInt
+    weight: StrictInt
+    port: StrictInt
+    flag: StrictInt
+    tag: StrictStr
+    value: StrictStr
+    __properties: ClassVar[List[str]] = ["Line", "name", "ttl", "type", "address", "cname", "exchange", "preference", "txtdata", "unencoded", "target", "priority", "weight", "port", "flag", "tag", "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 DNSRecord 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.
+        * 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([
+            "line",
+            "name",
+            "ttl",
+            "type",
+            "address",
+            "cname",
+            "exchange",
+            "preference",
+            "txtdata",
+            "unencoded",
+            "target",
+            "priority",
+            "weight",
+            "port",
+            "flag",
+            "tag",
+            "value",
+        ])
+
+        _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 DNSRecord from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "Line": obj.get("Line"),
+            "name": obj.get("name"),
+            "ttl": obj.get("ttl"),
+            "type": obj.get("type"),
+            "address": obj.get("address"),
+            "cname": obj.get("cname"),
+            "exchange": obj.get("exchange"),
+            "preference": obj.get("preference"),
+            "txtdata": obj.get("txtdata"),
+            "unencoded": obj.get("unencoded"),
+            "target": obj.get("target"),
+            "priority": obj.get("priority"),
+            "weight": obj.get("weight"),
+            "port": obj.get("port"),
+            "flag": obj.get("flag"),
+            "tag": obj.get("tag"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

pidginhost_sdk/models/dns_record_create.py

@@ -0,0 +1,121 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from pidginhost_sdk.models.dns_record_create_type_enum import DNSRecordCreateTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DNSRecordCreate(BaseModel):
+    """
+    Validate input for creating or editing a DNS record.
+    """ # noqa: E501
+    name: StrictStr = Field(description="Record hostname (use '@' or leave empty for zone apex).")
+    ttl: StrictInt = Field(description="Time to live in seconds.")
+    type: DNSRecordCreateTypeEnum = Field(description="DNS record type.  * `A` - A * `AAAA` - AAAA * `TYPE257` - TYPE257 * `CNAME` - CNAME * `MX` - MX * `SRV` - SRV * `TXT` - TXT")
+    address: Optional[StrictStr] = Field(default=None, description="IPv4/IPv6 address (A/AAAA).")
+    cname: Optional[StrictStr] = Field(default=None, description="Canonical name (CNAME).")
+    exchange: Optional[StrictStr] = Field(default=None, description="Mail exchange host (MX).")
+    preference: Optional[StrictInt] = Field(default=None, description="MX preference / priority.")
+    txtdata: Optional[StrictStr] = Field(default=None, description="TXT record data.")
+    unencoded: Optional[StrictStr] = Field(default=None, description="Unencoded TXT value.")
+    target: Optional[StrictStr] = Field(default=None, description="SRV target host.")
+    priority: Optional[StrictInt] = Field(default=None, description="SRV priority.")
+    weight: Optional[StrictInt] = Field(default=None, description="SRV weight.")
+    port: Optional[StrictInt] = Field(default=None, description="SRV port.")
+    flag: Optional[StrictInt] = Field(default=None, description="CAA flag (TYPE257).")
+    tag: Optional[StrictStr] = Field(default=None, description="CAA tag (TYPE257).")
+    value: Optional[StrictStr] = Field(default=None, description="CAA value (TYPE257).")
+    line: Optional[StrictInt] = Field(default=None, description="Line number of existing record to edit. Omit to add a new record.")
+    __properties: ClassVar[List[str]] = ["name", "ttl", "type", "address", "cname", "exchange", "preference", "txtdata", "unencoded", "target", "priority", "weight", "port", "flag", "tag", "value", "line"]
+
+    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 DNSRecordCreate 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 DNSRecordCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "ttl": obj.get("ttl"),
+            "type": obj.get("type"),
+            "address": obj.get("address"),
+            "cname": obj.get("cname"),
+            "exchange": obj.get("exchange"),
+            "preference": obj.get("preference"),
+            "txtdata": obj.get("txtdata"),
+            "unencoded": obj.get("unencoded"),
+            "target": obj.get("target"),
+            "priority": obj.get("priority"),
+            "weight": obj.get("weight"),
+            "port": obj.get("port"),
+            "flag": obj.get("flag"),
+            "tag": obj.get("tag"),
+            "value": obj.get("value"),
+            "line": obj.get("line")
+        })
+        return _obj
+
+

pidginhost_sdk/models/dns_record_create_type_enum.py

@@ -0,0 +1,43 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DNSRecordCreateTypeEnum(str, Enum):
+    """
+    * `A` - A * `AAAA` - AAAA * `TYPE257` - TYPE257 * `CNAME` - CNAME * `MX` - MX * `SRV` - SRV * `TXT` - TXT
+    """
+
+    """
+    allowed enum values
+    """
+    A = 'A'
+    AAAA = 'AAAA'
+    TYPE257 = 'TYPE257'
+    CNAME = 'CNAME'
+    MX = 'MX'
+    SRV = 'SRV'
+    TXT = 'TXT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DNSRecordCreateTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))
+
+