Fix issue #52: Replace enums by string in response models

Author: Ihor Bilous

README.md

@@ -70,7 +70,7 @@ IS_SANDBOX = os.environ.get("MAILTRAP_USE_SANDBOX", "true").lower() == "true"
 INBOX_ID = os.environ.get("MAILTRAP_INBOX_ID")
 
 client = mt.MailtrapClient(
-  token=API_KEY, 
+  token=API_KEY,
   sandbox=IS_SANDBOX,
   inbox_id=INBOX_ID,  # None is ignored for production
 )

mailtrap/models/contacts.py

@@ -1,5 +1,4 @@
 from datetime import datetime
-from enum import Enum
 from typing import Any
 from typing import Optional
 from typing import Union
@@ -45,11 +44,6 @@ class ContactList:
     name: str
 
 
-class ContactStatus(str, Enum):
-    SUBSCRIBED = "subscribed"
-    UNSUBSCRIBED = "unsubscribed"
-
-
 @dataclass
 class CreateContactParams(RequestParams):
     email: str
@@ -89,7 +83,7 @@ class Contact:
     email: str
     fields: dict[str, Union[str, int, float, bool]]  # field_merge_tag: value
     list_ids: list[int]
-    status: ContactStatus
+    status: str
     created_at: int
     updated_at: int
 
@@ -99,17 +93,10 @@ class ContactResponse:
     data: Contact
 
 
-class ContactImportStatus(str, Enum):
-    CREATED = "created"
-    STARTED = "started"
-    FINISHED = "finished"
-    FAILED = "failed"
-
-
 @dataclass
 class ContactImport:
     id: int
-    status: ContactImportStatus
+    status: str
     created_contacts_count: Optional[int] = None
     updated_contacts_count: Optional[int] = None
     contacts_over_limit_count: Optional[int] = None

mailtrap/models/messages.py

@@ -1,5 +1,4 @@
 from datetime import datetime
-from enum import Enum
 from typing import Any
 from typing import Optional
 from typing import Union
@@ -10,12 +9,6 @@
 from mailtrap.models.common import RequestParams
 
 
-class BlacklistsResult(str, Enum):
-    SUCCESS = "success"
-    PENDING = "pending"
-    ERROR = "error"
-
-
 @dataclass
 class BlacklistsReport:
     name: str
@@ -25,7 +18,7 @@ class BlacklistsReport:
 
 @dataclass
 class Blacklists:
-    result: BlacklistsResult
+    result: str
     domain: str
     ip: str
     report: list[BlacklistsReport]
@@ -117,14 +110,9 @@ class ErrorItem:
     email_clients: EmailClients
 
 
-class AnalysisReportStatus(str, Enum):
-    SUCCESS = "success"
-    ERROR = "error"
-
-
 @dataclass
 class AnalysisReport:
-    status: AnalysisReportStatus
+    status: str
 
 
 @dataclass

mailtrap/models/suppressions.py

@@ -1,30 +1,17 @@
 from datetime import datetime
-from enum import Enum
 from typing import Optional
 from typing import Union
 
 from pydantic.dataclasses import dataclass
 
 
-class SuppressionType(str, Enum):
-    HARD_BOUNCE = "hard bounce"
-    SPAM_COMPLAINT = "spam complaint"
-    UNSUBSCRIPTION = "unsubscription"
-    MANUAL_IMPORT = "manual import"
-
-
-class SendingStream(str, Enum):
-    TRANSACTIONAL = "transactional"
-    BULK = "bulk"
-
-
 @dataclass
 class Suppression:
     id: str
-    type: SuppressionType
+    type: str
     created_at: datetime
     email: str
-    sending_stream: SendingStream
+    sending_stream: str
     domain_name: Optional[str] = None
     message_bounce_category: Optional[str] = None
     message_category: Optional[str] = None

tests/unit/api/contacts/test_contact_imports.py

@@ -8,7 +8,6 @@
 from mailtrap.exceptions import APIError
 from mailtrap.http import HttpClient
 from mailtrap.models.contacts import ContactImport
-from mailtrap.models.contacts import ContactImportStatus
 from mailtrap.models.contacts import ImportContactParams
 from tests import conftest
 
@@ -135,7 +134,7 @@ def test_import_contacts_should_return_started_import(
 
         assert isinstance(contact_import, ContactImport)
         assert contact_import.id == IMPORT_ID
-        assert contact_import.status == ContactImportStatus.STARTED
+        assert contact_import.status == "started"
 
     @pytest.mark.parametrize(
         "status_code,response_json,expected_error_message",
@@ -190,7 +189,7 @@ def test_get_contact_import_should_return_started_import(
 
         assert isinstance(contact_import, ContactImport)
         assert contact_import.id == IMPORT_ID
-        assert contact_import.status == ContactImportStatus.STARTED
+        assert contact_import.status == "started"
 
     @responses.activate
     def test_get_contact_import_should_return_finished_import(
@@ -208,7 +207,7 @@ def test_get_contact_import_should_return_finished_import(
 
         assert isinstance(contact_import, ContactImport)
         assert contact_import.id == IMPORT_ID
-        assert contact_import.status == ContactImportStatus.FINISHED
+        assert contact_import.status == "finished"
         assert contact_import.created_contacts_count == 1
         assert contact_import.updated_contacts_count == 3
         assert contact_import.contacts_over_limit_count == 3

tests/unit/api/contacts/test_contacts.py

@@ -9,7 +9,6 @@
 from mailtrap.http import HttpClient
 from mailtrap.models.common import DeletedObject
 from mailtrap.models.contacts import Contact
-from mailtrap.models.contacts import ContactStatus
 from mailtrap.models.contacts import CreateContactParams
 from mailtrap.models.contacts import UpdateContactParams
 from tests import conftest
@@ -122,7 +121,7 @@ def test_get_contact_should_return_contact(
         assert isinstance(contact, Contact)
         assert contact.id == CONTACT_ID
         assert contact.email == "john.smith@example.com"
-        assert contact.status == ContactStatus.SUBSCRIBED
+        assert contact.status == "subscribed"
         assert contact.fields["first_name"] == "John"
         assert contact.fields["last_name"] == "Smith"
         assert contact.list_ids == [1, 2, 3]
@@ -210,7 +209,7 @@ def test_create_contact_should_return_created_contact(
         assert isinstance(contact, Contact)
         assert contact.id == CONTACT_ID
         assert contact.email == "john.smith@example.com"
-        assert contact.status == ContactStatus.SUBSCRIBED
+        assert contact.status == "subscribed"
         assert contact.fields["first_name"] == "John"
         assert contact.fields["last_name"] == "Smith"
         assert contact.list_ids == [1, 2, 3]
@@ -297,7 +296,7 @@ def test_update_contact_should_return_updated_contact(
         assert isinstance(contact, Contact)
         assert contact.id == CONTACT_ID
         assert contact.email == "john.updated@example.com"
-        assert contact.status == ContactStatus.SUBSCRIBED
+        assert contact.status == "subscribed"
         assert contact.fields["first_name"] == "John Updated"
         assert contact.fields["last_name"] == "Smith Updated"
 

tests/unit/api/suppressions/test_suppressions.py

@@ -8,9 +8,7 @@
 from mailtrap.config import GENERAL_HOST
 from mailtrap.exceptions import APIError
 from mailtrap.http import HttpClient
-from mailtrap.models.suppressions import SendingStream
 from mailtrap.models.suppressions import Suppression
-from mailtrap.models.suppressions import SuppressionType
 from tests import conftest
 
 ACCOUNT_ID = "321"
@@ -168,6 +166,6 @@ def test_delete_suppression_should_return_deleted_suppression(
 
         assert isinstance(deleted_suppression, Suppression)
         assert deleted_suppression.id == SUPPRESSION_ID
-        assert deleted_suppression.type == SuppressionType.UNSUBSCRIPTION
+        assert deleted_suppression.type == "unsubscription"
         assert deleted_suppression.email == "recipient@example.com"
-        assert deleted_suppression.sending_stream == SendingStream.TRANSACTIONAL
+        assert deleted_suppression.sending_stream == "transactional"

tests/unit/api/testing/test_messages.py

@@ -543,7 +543,7 @@ def test_get_html_analysis_should_return_analysis_report(
 
         result = client.get_html_analysis(INBOX_ID, MESSAGE_ID)
 
-        assert result.status.value == "success"
+        assert result.status == "success"
         assert len(result.errors) == 1
         assert result.errors[0].error_line == 15