Fix issue #19: Add _api_path method in Api classes

Author: Ihor Bilous

examples/contacts/contact_fields.py

@@ -25,7 +25,7 @@ def create_contact_field(
 
 
 def update_contact_field(
-    contact_field_id: str,
+    contact_field_id: int,
     name: Optional[str] = None,
     merge_tag: Optional[str] = None,
 ) -> ContactField:
@@ -37,11 +37,11 @@ def list_contact_fields() -> list[ContactField]:
     return contact_fields_api.get_list()
 
 
-def get_contact_field(contact_field_id: str) -> ContactField:
+def get_contact_field(contact_field_id: int) -> ContactField:
     return contact_fields_api.get_by_id(contact_field_id)
 
 
-def delete_contact_field(contact_field_id: str) -> DeletedObject:
+def delete_contact_field(contact_field_id: int) -> DeletedObject:
     return contact_fields_api.delete(contact_field_id)
 
 

mailtrap/api/resources/contact_fields.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from mailtrap.http import HttpClient
 from mailtrap.models.common import DeletedObject
 from mailtrap.models.contacts import ContactField
@@ -11,18 +13,18 @@ def __init__(self, client: HttpClient, account_id: str) -> None:
         self._client = client
 
     def get_list(self) -> list[ContactField]:
-        response = self._client.get(f"/api/accounts/{self._account_id}/contacts/fields")
+        response = self._client.get(self._api_path())
         return [ContactField(**field) for field in response]
 
     def get_by_id(self, field_id: int) -> ContactField:
         response = self._client.get(
-            f"/api/accounts/{self._account_id}/contacts/fields/{field_id}"
+            self._api_path(field_id),
         )
         return ContactField(**response)
 
     def create(self, field_params: CreateContactFieldParams) -> ContactField:
         response = self._client.post(
-            f"/api/accounts/{self._account_id}/contacts/fields",
+            self._api_path(),
             json=field_params.api_data,
         )
         return ContactField(**response)
@@ -31,13 +33,17 @@ def update(
         self, field_id: int, field_params: UpdateContactFieldParams
     ) -> ContactField:
         response = self._client.patch(
-            f"/api/accounts/{self._account_id}/contacts/fields/{field_id}",
+            self._api_path(field_id),
             json=field_params.api_data,
         )
         return ContactField(**response)
 
     def delete(self, field_id: int) -> DeletedObject:
-        self._client.delete(
-            f"/api/accounts/{self._account_id}/contacts/fields/{field_id}"
-        )
+        self._client.delete(self._api_path(field_id))
         return DeletedObject(field_id)
+
+    def _api_path(self, field_id: Optional[int] = None) -> str:
+        path = f"/api/accounts/{self._account_id}/contacts/fields"
+        if field_id:
+            return f"{path}/{field_id}"
+        return path

mailtrap/api/resources/projects.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from mailtrap.http import HttpClient
 from mailtrap.models.common import DeletedObject
 from mailtrap.models.projects import Project
@@ -9,31 +11,33 @@ def __init__(self, client: HttpClient, account_id: str) -> None:
         self._client = client
 
     def get_list(self) -> list[Project]:
-        response = self._client.get(f"/api/accounts/{self._account_id}/projects")
+        response = self._client.get(self._api_path())
         return [Project(**project) for project in response]
 
     def get_by_id(self, project_id: int) -> Project:
-        response = self._client.get(
-            f"/api/accounts/{self._account_id}/projects/{project_id}"
-        )
+        response = self._client.get(self._api_path(project_id))
         return Project(**response)
 
     def create(self, project_name: str) -> Project:
         response = self._client.post(
-            f"/api/accounts/{self._account_id}/projects",
+            self._api_path(),
             json={"project": {"name": project_name}},
         )
         return Project(**response)
 
     def update(self, project_id: int, project_name: str) -> Project:
         response = self._client.patch(
-            f"/api/accounts/{self._account_id}/projects/{project_id}",
+            self._api_path(project_id),
             json={"project": {"name": project_name}},
         )
         return Project(**response)
 
     def delete(self, project_id: int) -> DeletedObject:
-        response = self._client.delete(
-            f"/api/accounts/{self._account_id}/projects/{project_id}",
-        )
+        response = self._client.delete(self._api_path(project_id))
         return DeletedObject(**response)
+
+    def _api_path(self, project_id: Optional[int] = None) -> str:
+        path = f"/api/accounts/{self._account_id}/projects"
+        if project_id:
+            return f"{path}/{project_id}"
+        return path

mailtrap/api/resources/templates.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from mailtrap.http import HttpClient
 from mailtrap.models.common import DeletedObject
 from mailtrap.models.templates import CreateEmailTemplateParams
@@ -11,18 +13,16 @@ def __init__(self, client: HttpClient, account_id: str) -> None:
         self._client = client
 
     def get_list(self) -> list[EmailTemplate]:
-        response = self._client.get(f"/api/accounts/{self._account_id}/email_templates")
+        response = self._client.get(self._api_path())
         return [EmailTemplate(**template) for template in response]
 
     def get_by_id(self, template_id: int) -> EmailTemplate:
-        response = self._client.get(
-            f"/api/accounts/{self._account_id}/email_templates/{template_id}"
-        )
+        response = self._client.get(self._api_path(template_id))
         return EmailTemplate(**response)
 
     def create(self, template_params: CreateEmailTemplateParams) -> EmailTemplate:
         response = self._client.post(
-            f"/api/accounts/{self._account_id}/email_templates",
+            self._api_path(),
             json={"email_template": template_params.api_data},
         )
         return EmailTemplate(**response)
@@ -31,13 +31,17 @@ def update(
         self, template_id: int, template_params: UpdateEmailTemplateParams
     ) -> EmailTemplate:
         response = self._client.patch(
-            f"/api/accounts/{self._account_id}/email_templates/{template_id}",
+            self._api_path(template_id),
             json={"email_template": template_params.api_data},
         )
         return EmailTemplate(**response)
 
     def delete(self, template_id: int) -> DeletedObject:
-        self._client.delete(
-            f"/api/accounts/{self._account_id}/email_templates/{template_id}"
-        )
+        self._client.delete(self._api_path(template_id))
         return DeletedObject(template_id)
+
+    def _api_path(self, template_id: Optional[int] = None) -> str:
+        path = f"/api/accounts/{self._account_id}/email_templates"
+        if template_id:
+            return f"{path}/{template_id}"
+        return path