feat(tem): add auto-configuration state in domain validation (#682)

scaleway-bot · Laure-di · web-flow · commit 2dfca8214945 · 2024-10-10T15:58:59.000Z
Co-authored-by: Laure-di &lt;62625835+Laure-di@users.noreply.github.com&gt;
diff --git a/scaleway-async/scaleway_async/tem/v1alpha1/__init__.py b/scaleway-async/scaleway_async/tem/v1alpha1/__init__.py
@@ -1,5 +1,6 @@
 # This file was automatically generated. DO NOT EDIT.
 # If you have any remark or suggestion do not hesitate to open an issue.
+from .types import DomainLastStatusAutoconfigStateReason
 from .types import DomainLastStatusRecordStatus
 from .types import DomainReputationStatus
 from .types import DomainStatus
@@ -23,6 +24,7 @@
 from .types import CreateEmailRequestAttachment
 from .types import CreateEmailRequestHeader
 from .types import Email
+from .types import DomainLastStatusAutoconfigState
 from .types import DomainLastStatusDkimRecord
 from .types import DomainLastStatusDmarcRecord
 from .types import DomainLastStatusSpfRecord
@@ -62,6 +64,7 @@
 from .api import TemV1Alpha1API
 
 __all__ = [
+    "DomainLastStatusAutoconfigStateReason",
     "DomainLastStatusRecordStatus",
     "DomainReputationStatus",
     "DomainStatus",
@@ -85,6 +88,7 @@
     "CreateEmailRequestAttachment",
     "CreateEmailRequestHeader",
     "Email",
+    "DomainLastStatusAutoconfigState",
     "DomainLastStatusDkimRecord",
     "DomainLastStatusDmarcRecord",
     "DomainLastStatusSpfRecord",
diff --git a/scaleway-async/scaleway_async/tem/v1alpha1/marshalling.py b/scaleway-async/scaleway_async/tem/v1alpha1/marshalling.py
@@ -17,6 +17,7 @@
     Domain,
     Webhook,
     CreateEmailResponse,
+    DomainLastStatusAutoconfigState,
     DomainLastStatusDkimRecord,
     DomainLastStatusDmarcRecord,
     DomainLastStatusSpfRecord,
@@ -423,6 +424,33 @@ def unmarshal_CreateEmailResponse(data: Any) -> CreateEmailResponse:
     return CreateEmailResponse(**args)
 
 
+def unmarshal_DomainLastStatusAutoconfigState(
+    data: Any,
+) -> DomainLastStatusAutoconfigState:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'DomainLastStatusAutoconfigState' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("enabled", None)
+    if field is not None:
+        args["enabled"] = field
+
+    field = data.get("autoconfigurable", None)
+    if field is not None:
+        args["autoconfigurable"] = field
+
+    field = data.get("reason", None)
+    if field is not None:
+        args["reason"] = field
+    else:
+        args["reason"] = None
+
+    return DomainLastStatusAutoconfigState(**args)
+
+
 def unmarshal_DomainLastStatusDkimRecord(data: Any) -> DomainLastStatusDkimRecord:
     if not isinstance(data, dict):
         raise TypeError(
@@ -544,6 +572,12 @@ def unmarshal_DomainLastStatus(data: Any) -> DomainLastStatus:
     else:
         args["dmarc_record"] = None
 
+    field = data.get("autoconfig_state", None)
+    if field is not None:
+        args["autoconfig_state"] = unmarshal_DomainLastStatusAutoconfigState(field)
+    else:
+        args["autoconfig_state"] = None
+
     return DomainLastStatus(**args)
 
 
diff --git a/scaleway-async/scaleway_async/tem/v1alpha1/types.py b/scaleway-async/scaleway_async/tem/v1alpha1/types.py
@@ -15,6 +15,15 @@
 )
 
 
+class DomainLastStatusAutoconfigStateReason(str, Enum, metaclass=StrEnumMeta):
+    UNKNOWN_REASON = "unknown_reason"
+    PERMISSION_DENIED = "permission_denied"
+    DOMAIN_NOT_FOUND = "domain_not_found"
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+
 class DomainLastStatusRecordStatus(str, Enum, metaclass=StrEnumMeta):
     UNKNOWN_RECORD_STATUS = "unknown_record_status"
     VALID = "valid"
@@ -358,6 +367,24 @@ class Email:
     """
 
 
+@dataclass
+class DomainLastStatusAutoconfigState:
+    enabled: bool
+    """
+    Enable or disable the auto-configuration of domain DNS records.
+    """
+
+    autoconfigurable: bool
+    """
+    Whether the domain can be auto-configured or not.
+    """
+
+    reason: Optional[DomainLastStatusAutoconfigStateReason]
+    """
+    The reason that the domain cannot be auto-configurable.
+    """
+
+
 @dataclass
 class DomainLastStatusDkimRecord:
     status: DomainLastStatusRecordStatus
@@ -638,12 +665,12 @@ class UpdateProjectSettingsRequestUpdatePeriodicReport:
 
     frequency: Optional[ProjectSettingsPeriodicReportFrequency]
     """
-    (Optional) At which frequency you receive periodic report notifications.
+    (Optional) Frequency at which you receive periodic report notifications.
     """
 
     sending_hour: Optional[int]
     """
-    (Optional) At which hour you receive periodic report notifications.
+    (Optional) Hour at which you receive periodic report notifications.
     """
 
     sending_day: Optional[int]
@@ -850,6 +877,11 @@ class DomainLastStatus:
     The DMARC record verification data.
     """
 
+    autoconfig_state: Optional[DomainLastStatusAutoconfigState]
+    """
+    The verification state of domain auto-configuration.
+    """
+
 
 @dataclass
 class GetDomainLastStatusRequest:
diff --git a/scaleway/scaleway/tem/v1alpha1/__init__.py b/scaleway/scaleway/tem/v1alpha1/__init__.py
@@ -1,5 +1,6 @@
 # This file was automatically generated. DO NOT EDIT.
 # If you have any remark or suggestion do not hesitate to open an issue.
+from .types import DomainLastStatusAutoconfigStateReason
 from .types import DomainLastStatusRecordStatus
 from .types import DomainReputationStatus
 from .types import DomainStatus
@@ -23,6 +24,7 @@
 from .types import CreateEmailRequestAttachment
 from .types import CreateEmailRequestHeader
 from .types import Email
+from .types import DomainLastStatusAutoconfigState
 from .types import DomainLastStatusDkimRecord
 from .types import DomainLastStatusDmarcRecord
 from .types import DomainLastStatusSpfRecord
@@ -62,6 +64,7 @@
 from .api import TemV1Alpha1API
 
 __all__ = [
+    "DomainLastStatusAutoconfigStateReason",
     "DomainLastStatusRecordStatus",
     "DomainReputationStatus",
     "DomainStatus",
@@ -85,6 +88,7 @@
     "CreateEmailRequestAttachment",
     "CreateEmailRequestHeader",
     "Email",
+    "DomainLastStatusAutoconfigState",
     "DomainLastStatusDkimRecord",
     "DomainLastStatusDmarcRecord",
     "DomainLastStatusSpfRecord",
diff --git a/scaleway/scaleway/tem/v1alpha1/marshalling.py b/scaleway/scaleway/tem/v1alpha1/marshalling.py
@@ -17,6 +17,7 @@
     Domain,
     Webhook,
     CreateEmailResponse,
+    DomainLastStatusAutoconfigState,
     DomainLastStatusDkimRecord,
     DomainLastStatusDmarcRecord,
     DomainLastStatusSpfRecord,
@@ -423,6 +424,33 @@ def unmarshal_CreateEmailResponse(data: Any) -> CreateEmailResponse:
     return CreateEmailResponse(**args)
 
 
+def unmarshal_DomainLastStatusAutoconfigState(
+    data: Any,
+) -> DomainLastStatusAutoconfigState:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'DomainLastStatusAutoconfigState' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("enabled", None)
+    if field is not None:
+        args["enabled"] = field
+
+    field = data.get("autoconfigurable", None)
+    if field is not None:
+        args["autoconfigurable"] = field
+
+    field = data.get("reason", None)
+    if field is not None:
+        args["reason"] = field
+    else:
+        args["reason"] = None
+
+    return DomainLastStatusAutoconfigState(**args)
+
+
 def unmarshal_DomainLastStatusDkimRecord(data: Any) -> DomainLastStatusDkimRecord:
     if not isinstance(data, dict):
         raise TypeError(
@@ -544,6 +572,12 @@ def unmarshal_DomainLastStatus(data: Any) -> DomainLastStatus:
     else:
         args["dmarc_record"] = None
 
+    field = data.get("autoconfig_state", None)
+    if field is not None:
+        args["autoconfig_state"] = unmarshal_DomainLastStatusAutoconfigState(field)
+    else:
+        args["autoconfig_state"] = None
+
     return DomainLastStatus(**args)
 
 
diff --git a/scaleway/scaleway/tem/v1alpha1/types.py b/scaleway/scaleway/tem/v1alpha1/types.py
@@ -15,6 +15,15 @@
 )
 
 
+class DomainLastStatusAutoconfigStateReason(str, Enum, metaclass=StrEnumMeta):
+    UNKNOWN_REASON = "unknown_reason"
+    PERMISSION_DENIED = "permission_denied"
+    DOMAIN_NOT_FOUND = "domain_not_found"
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+
 class DomainLastStatusRecordStatus(str, Enum, metaclass=StrEnumMeta):
     UNKNOWN_RECORD_STATUS = "unknown_record_status"
     VALID = "valid"
@@ -358,6 +367,24 @@ class Email:
     """
 
 
+@dataclass
+class DomainLastStatusAutoconfigState:
+    enabled: bool
+    """
+    Enable or disable the auto-configuration of domain DNS records.
+    """
+
+    autoconfigurable: bool
+    """
+    Whether the domain can be auto-configured or not.
+    """
+
+    reason: Optional[DomainLastStatusAutoconfigStateReason]
+    """
+    The reason that the domain cannot be auto-configurable.
+    """
+
+
 @dataclass
 class DomainLastStatusDkimRecord:
     status: DomainLastStatusRecordStatus
@@ -638,12 +665,12 @@ class UpdateProjectSettingsRequestUpdatePeriodicReport:
 
     frequency: Optional[ProjectSettingsPeriodicReportFrequency]
     """
-    (Optional) At which frequency you receive periodic report notifications.
+    (Optional) Frequency at which you receive periodic report notifications.
     """
 
     sending_hour: Optional[int]
     """
-    (Optional) At which hour you receive periodic report notifications.
+    (Optional) Hour at which you receive periodic report notifications.
     """
 
     sending_day: Optional[int]
@@ -850,6 +877,11 @@ class DomainLastStatus:
     The DMARC record verification data.
     """
 
+    autoconfig_state: Optional[DomainLastStatusAutoconfigState]
+    """
+    The verification state of domain auto-configuration.
+    """
+
 
 @dataclass
 class GetDomainLastStatusRequest:
