feat(tem): add link to documentation and console (#351)

Author: scaleway-bot

scaleway-async/scaleway_async/tem/v1alpha1/api.py

@@ -471,7 +471,7 @@ async def get_domain(
     ) -> Domain:
         """
         Get information about a domain.
-        Retrieve information about a specific domain using the `region` and `domain_id` parameters.
+        Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
         :param region: Region to target. If none is passed will use default region from the config.
         :param domain_id: ID of the domain.
         :return: :class:`Domain <Domain>`
@@ -543,7 +543,7 @@ async def list_domains(
     ) -> ListDomainsResponse:
         """
         List domains.
-        Retrieve domains in a specific project or in a specific Organization using the `region` parameter.
+        Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
         :param region: Region to target. If none is passed will use default region from the config.
         :param page: Requested page number. Value must be greater or equal to 1.
         :param page_size: Page size.
@@ -593,7 +593,7 @@ async def list_domains_all(
     ) -> List[Domain]:
         """
         List domains.
-        Retrieve domains in a specific project or in a specific Organization using the `region` parameter.
+        Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
         :param region: Region to target. If none is passed will use default region from the config.
         :param page: Requested page number. Value must be greater or equal to 1.
         :param page_size: Page size.

scaleway-async/scaleway_async/tem/v1alpha1/types.py

@@ -26,7 +26,7 @@ def __str__(self) -> str:
 
 
 class DomainReputationStatus(str, Enum, metaclass=StrEnumMeta):
-    UNKNOWN = "unknown"
+    UNKNOWN_STATUS = "unknown_status"
     EXCELLENT = "excellent"
     GOOD = "good"
     AVERAGE = "average"
@@ -228,7 +228,7 @@ class Domain:
 
     reputation: Optional[DomainReputation]
     """
-    Domain's reputation, available when your domain is checked and has sent enough emails.
+    The domain's reputation is available when your domain is checked and has sent enough emails.
     """
 
     region: Region
@@ -242,7 +242,7 @@ class DomainLastStatus:
 
     domain_id: str
     """
-    The id of the domain.
+    The ID of the domain.
     """
 
     domain_name: str
@@ -313,12 +313,12 @@ class DomainReputation:
 
     status: DomainReputationStatus
     """
-    Status of your domain reputation.
+    Status of your domain's reputation.
     """
 
     score: int
     """
-    Represent a number between 0 and 100 of your domain reputation score.
+    A range from 0 to 100 that determines your domain's reputation score. A score of `0` means a bad domain reputation and a score of `100` means an excellent domain reputation.
     """
 
     scored_at: Optional[datetime]
@@ -328,12 +328,12 @@ class DomainReputation:
 
     previous_score: Optional[int]
     """
-    The domain reputation score previously calculated.
+    The previously-calculated domain's reputation score.
     """
 
     previous_scored_at: Optional[datetime]
     """
-    Time and date the previous score was calculated.
+    Time and date the previous reputation score was calculated.
     """
 
 

scaleway/scaleway/tem/v1alpha1/api.py

@@ -471,7 +471,7 @@ def get_domain(
     ) -> Domain:
         """
         Get information about a domain.
-        Retrieve information about a specific domain using the `region` and `domain_id` parameters.
+        Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
         :param region: Region to target. If none is passed will use default region from the config.
         :param domain_id: ID of the domain.
         :return: :class:`Domain <Domain>`
@@ -543,7 +543,7 @@ def list_domains(
     ) -> ListDomainsResponse:
         """
         List domains.
-        Retrieve domains in a specific project or in a specific Organization using the `region` parameter.
+        Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
         :param region: Region to target. If none is passed will use default region from the config.
         :param page: Requested page number. Value must be greater or equal to 1.
         :param page_size: Page size.
@@ -593,7 +593,7 @@ def list_domains_all(
     ) -> List[Domain]:
         """
         List domains.
-        Retrieve domains in a specific project or in a specific Organization using the `region` parameter.
+        Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
         :param region: Region to target. If none is passed will use default region from the config.
         :param page: Requested page number. Value must be greater or equal to 1.
         :param page_size: Page size.

scaleway/scaleway/tem/v1alpha1/types.py

@@ -26,7 +26,7 @@ def __str__(self) -> str:
 
 
 class DomainReputationStatus(str, Enum, metaclass=StrEnumMeta):
-    UNKNOWN = "unknown"
+    UNKNOWN_STATUS = "unknown_status"
     EXCELLENT = "excellent"
     GOOD = "good"
     AVERAGE = "average"
@@ -228,7 +228,7 @@ class Domain:
 
     reputation: Optional[DomainReputation]
     """
-    Domain's reputation, available when your domain is checked and has sent enough emails.
+    The domain's reputation is available when your domain is checked and has sent enough emails.
     """
 
     region: Region
@@ -242,7 +242,7 @@ class DomainLastStatus:
 
     domain_id: str
     """
-    The id of the domain.
+    The ID of the domain.
     """
 
     domain_name: str
@@ -313,12 +313,12 @@ class DomainReputation:
 
     status: DomainReputationStatus
     """
-    Status of your domain reputation.
+    Status of your domain's reputation.
     """
 
     score: int
     """
-    Represent a number between 0 and 100 of your domain reputation score.
+    A range from 0 to 100 that determines your domain's reputation score. A score of `0` means a bad domain reputation and a score of `100` means an excellent domain reputation.
     """
 
     scored_at: Optional[datetime]
@@ -328,12 +328,12 @@ class DomainReputation:
 
     previous_score: Optional[int]
     """
-    The domain reputation score previously calculated.
+    The previously-calculated domain's reputation score.
     """
 
     previous_scored_at: Optional[datetime]
     """
-    Time and date the previous score was calculated.
+    Time and date the previous reputation score was calculated.
     """