hostinger-mail-api 1.0.3__py3-none-any.whl

hostinger_mail_api/exceptions.py

@@ -0,0 +1,214 @@
+# coding: utf-8
+
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

hostinger_mail_api/models/__init__.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # noqa: E501
+
+
+# import models into model package
+from hostinger_mail_api.models.error import Error
+from hostinger_mail_api.models.pagination import Pagination
+from hostinger_mail_api.models.v1_folder_messages_collection import V1FolderMessagesCollection
+from hostinger_mail_api.models.v1_folder_messages_delete_bulk_request import V1FolderMessagesDeleteBulkRequest
+from hostinger_mail_api.models.v1_folder_messages_flags_bulk_request import V1FolderMessagesFlagsBulkRequest
+from hostinger_mail_api.models.v1_folder_messages_flags_request import V1FolderMessagesFlagsRequest
+from hostinger_mail_api.models.v1_folder_messages_message import V1FolderMessagesMessage
+from hostinger_mail_api.models.v1_folder_messages_message_address import V1FolderMessagesMessageAddress
+from hostinger_mail_api.models.v1_folder_messages_message_attachment import V1FolderMessagesMessageAttachment
+from hostinger_mail_api.models.v1_folder_messages_message_text import V1FolderMessagesMessageText
+from hostinger_mail_api.models.v1_folder_messages_message_text_resource import V1FolderMessagesMessageTextResource
+from hostinger_mail_api.models.v1_folder_messages_move_bulk_request import V1FolderMessagesMoveBulkRequest
+from hostinger_mail_api.models.v1_folder_messages_move_request import V1FolderMessagesMoveRequest
+from hostinger_mail_api.models.v1_folder_messages_resource import V1FolderMessagesResource
+from hostinger_mail_api.models.v1_folder_messages_search_request import V1FolderMessagesSearchRequest
+from hostinger_mail_api.models.v1_folder_messages_update_flags_result import V1FolderMessagesUpdateFlagsResult
+from hostinger_mail_api.models.v1_folder_messages_update_flags_result_data import V1FolderMessagesUpdateFlagsResultData
+from hostinger_mail_api.models.v1_folder_messages_update_flags_result_data_failed_inner import V1FolderMessagesUpdateFlagsResultDataFailedInner
+from hostinger_mail_api.models.v1_folders_collection import V1FoldersCollection
+from hostinger_mail_api.models.v1_folders_create_request import V1FoldersCreateRequest
+from hostinger_mail_api.models.v1_folders_folder import V1FoldersFolder
+from hostinger_mail_api.models.v1_folders_resource import V1FoldersResource
+from hostinger_mail_api.models.v1_folders_update_request import V1FoldersUpdateRequest
+from hostinger_mail_api.models.v1_me_mailbox import V1MeMailbox
+from hostinger_mail_api.models.v1_me_resource import V1MeResource
+from hostinger_mail_api.models.v1_me_resource_data import V1MeResourceData
+from hostinger_mail_api.models.v1_quota_quota import V1QuotaQuota
+from hostinger_mail_api.models.v1_quota_quota_resource import V1QuotaQuotaResource
+from hostinger_mail_api.models.v1_quota_resource import V1QuotaResource
+from hostinger_mail_api.models.v1_send_attachment import V1SendAttachment
+from hostinger_mail_api.models.v1_send_request import V1SendRequest
+from hostinger_mail_api.models.v1_webhooks_collection import V1WebhooksCollection
+from hostinger_mail_api.models.v1_webhooks_create_request import V1WebhooksCreateRequest
+from hostinger_mail_api.models.v1_webhooks_resource import V1WebhooksResource
+from hostinger_mail_api.models.v1_webhooks_resource_with_secret import V1WebhooksResourceWithSecret
+from hostinger_mail_api.models.v1_webhooks_test_result import V1WebhooksTestResult
+from hostinger_mail_api.models.v1_webhooks_test_result_data import V1WebhooksTestResultData
+from hostinger_mail_api.models.v1_webhooks_update_request import V1WebhooksUpdateRequest
+from hostinger_mail_api.models.v1_webhooks_webhook import V1WebhooksWebhook
+from hostinger_mail_api.models.v1_webhooks_webhook_with_secret import V1WebhooksWebhookWithSecret

hostinger_mail_api/models/error.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Error(BaseModel):
+    """
+    Standard error envelope. Frontend translations key off `code`, never off `error`.
+    """ # noqa: E501
+    error: StrictStr = Field(description="Human-readable error message.")
+    code: StrictStr = Field(description="Machine-readable error code in SCREAMING_SNAKE_CASE.")
+    params: Optional[Dict[str, Any]] = Field(default=None, description="Additional structured context for the error. May be omitted.")
+    __properties: ClassVar[List[str]] = ["error", "code", "params"]
+
+    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 Error 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 Error from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "error": obj.get("error"),
+            "code": obj.get("code"),
+            "params": obj.get("params")
+        })
+        return _obj
+
+

hostinger_mail_api/models/pagination.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # 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 Pagination(BaseModel):
+    """
+    Pagination metadata for paginated collections.
+    """ # noqa: E501
+    page: StrictInt = Field(description="Current page number (1-based).")
+    per_page: StrictInt = Field(description="Items per page.", alias="perPage")
+    total: StrictInt = Field(description="Total number of items across all pages.")
+    total_pages: StrictInt = Field(description="Total number of pages.", alias="totalPages")
+    __properties: ClassVar[List[str]] = ["page", "perPage", "total", "totalPages"]
+
+    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 Pagination 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 Pagination from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "page": obj.get("page"),
+            "perPage": obj.get("perPage"),
+            "total": obj.get("total"),
+            "totalPages": obj.get("totalPages")
+        })
+        return _obj
+
+

hostinger_mail_api/models/v1_folder_messages_collection.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # 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
+from hostinger_mail_api.models.pagination import Pagination
+from hostinger_mail_api.models.v1_folder_messages_message import V1FolderMessagesMessage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1FolderMessagesCollection(BaseModel):
+    """
+    Paginated list of messages.
+    """ # noqa: E501
+    data: List[V1FolderMessagesMessage]
+    pagination: Pagination
+    __properties: ClassVar[List[str]] = ["data", "pagination"]
+
+    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 V1FolderMessagesCollection 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
+        # override the default output from pydantic by calling `to_dict()` of pagination
+        if self.pagination:
+            _dict['pagination'] = self.pagination.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1FolderMessagesCollection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": [V1FolderMessagesMessage.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None,
+            "pagination": Pagination.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None
+        })
+        return _obj
+
+

hostinger_mail_api/models/v1_folder_messages_delete_bulk_request.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+"""
+    Hostinger Email API Python SDK
+
+    API Version: 1.0.0
+
+    NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
+    If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class V1FolderMessagesDeleteBulkRequest(BaseModel):
+    """
+    Body for permanently deleting multiple messages.
+    """ # noqa: E501
+    uids: Annotated[List[Annotated[int, Field(strict=True, ge=1)]], Field(min_length=1, max_length=100)] = Field(description="Message UIDs to delete. 1-100 entries, each > 0.")
+    __properties: ClassVar[List[str]] = ["uids"]
+
+    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 V1FolderMessagesDeleteBulkRequest 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 V1FolderMessagesDeleteBulkRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uids": obj.get("uids")
+        })
+        return _obj
+
+