Skip to content

Commit aa0bae0

Browse files
scaleway-botscaleway-bot
authored
feat(tem): add mx records validation in get domain last status (#1238)
1 parent e974776 commit aa0bae0

File tree

8 files changed

+134
-8
lines changed

8 files changed

+134
-8
lines changed

‎scaleway-async/scaleway_async/tem/v1alpha1/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
from .types import DomainLastStatusAutoconfigState
3333
from .types import DomainLastStatusDkimRecord
3434
from .types import DomainLastStatusDmarcRecord
35+
from .types import DomainLastStatusMXRecord
3536
from .types import DomainLastStatusSpfRecord
3637
from .types import Domain
3738
from .types import OfferSubscription
@@ -118,6 +119,7 @@
118119
"DomainLastStatusAutoconfigState",
119120
"DomainLastStatusDkimRecord",
120121
"DomainLastStatusDmarcRecord",
122+
"DomainLastStatusMXRecord",
121123
"DomainLastStatusSpfRecord",
122124
"Domain",
123125
"OfferSubscription",

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -763,9 +763,9 @@ async def get_domain_last_status(
763763
region: Optional[ScwRegion] = None,
764764
) -> DomainLastStatus:
765765
"""
766-
Display SPF and DKIM records status and potential errors.
767-
Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
768-
:param domain_id: ID of the domain to delete.
766+
Display SPF, DKIM, DMARC and MX records status and potential errors.
767+
Display SPF, DKIM, DMARC and MX records status and potential errors, including the found records to make debugging easier.
768+
:param domain_id: ID of the domain to get records status.
769769
:param region: Region to target. If none is passed will use default region from the config.
770770
:return: :class:`DomainLastStatus <DomainLastStatus>`
771771

‎scaleway-async/scaleway_async/tem/v1alpha1/marshalling.py‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
DomainLastStatusAutoconfigState,
3535
DomainLastStatusDkimRecord,
3636
DomainLastStatusDmarcRecord,
37+
DomainLastStatusMXRecord,
3738
DomainLastStatusSpfRecord,
3839
DomainLastStatus,
3940
ListBlocklistsResponse,
@@ -783,6 +784,37 @@ def unmarshal_DomainLastStatusDmarcRecord(data: Any) -> DomainLastStatusDmarcRec
783784
return DomainLastStatusDmarcRecord(**args)
784785

785786

787+
def unmarshal_DomainLastStatusMXRecord(data: Any) -> DomainLastStatusMXRecord:
788+
if not isinstance(data, dict):
789+
raise TypeError(
790+
"Unmarshalling the type 'DomainLastStatusMXRecord' failed as data isn't a dictionary."
791+
)
792+
793+
args: dict[str, Any] = {}
794+
795+
field = data.get("status", None)
796+
if field is not None:
797+
args["status"] = field
798+
else:
799+
args["status"] = DomainLastStatusRecordStatus.UNKNOWN_RECORD_STATUS
800+
801+
field = data.get("last_valid_at", None)
802+
if field is not None:
803+
args["last_valid_at"] = (
804+
parser.isoparse(field) if isinstance(field, str) else field
805+
)
806+
else:
807+
args["last_valid_at"] = None
808+
809+
field = data.get("error", None)
810+
if field is not None:
811+
args["error"] = field
812+
else:
813+
args["error"] = None
814+
815+
return DomainLastStatusMXRecord(**args)
816+
817+
786818
def unmarshal_DomainLastStatusSpfRecord(data: Any) -> DomainLastStatusSpfRecord:
787819
if not isinstance(data, dict):
788820
raise TypeError(
@@ -852,6 +884,12 @@ def unmarshal_DomainLastStatus(data: Any) -> DomainLastStatus:
852884
else:
853885
args["dmarc_record"] = None
854886

887+
field = data.get("mx_record", None)
888+
if field is not None:
889+
args["mx_record"] = unmarshal_DomainLastStatusMXRecord(field)
890+
else:
891+
args["mx_record"] = None
892+
855893
field = data.get("autoconfig_state", None)
856894
if field is not None:
857895
args["autoconfig_state"] = unmarshal_DomainLastStatusAutoconfigState(field)

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,24 @@ class DomainLastStatusDmarcRecord:
511511
"""
512512

513513

514+
@dataclass
515+
class DomainLastStatusMXRecord:
516+
status: DomainLastStatusRecordStatus
517+
"""
518+
Status of the MX record's configuration. This record is optional to validate a domain, but highly recommended.
519+
"""
520+
521+
last_valid_at: Optional[datetime] = None
522+
"""
523+
Time and date the MX record was last valid.
524+
"""
525+
526+
error: Optional[str] = None
527+
"""
528+
An error text displays in case the record is not valid.
529+
"""
530+
531+
514532
@dataclass
515533
class DomainLastStatusSpfRecord:
516534
status: DomainLastStatusRecordStatus
@@ -1161,6 +1179,11 @@ class DomainLastStatus:
11611179
The DMARC record verification data.
11621180
"""
11631181

1182+
mx_record: Optional[DomainLastStatusMXRecord] = None
1183+
"""
1184+
The MX record verification data.
1185+
"""
1186+
11641187
autoconfig_state: Optional[DomainLastStatusAutoconfigState] = None
11651188
"""
11661189
The verification state of domain auto-configuration.
@@ -1171,7 +1194,7 @@ class DomainLastStatus:
11711194
class GetDomainLastStatusRequest:
11721195
domain_id: str
11731196
"""
1174-
ID of the domain to delete.
1197+
ID of the domain to get records status.
11751198
"""
11761199

11771200
region: Optional[ScwRegion] = None

‎scaleway/scaleway/tem/v1alpha1/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
from .types import DomainLastStatusAutoconfigState
3333
from .types import DomainLastStatusDkimRecord
3434
from .types import DomainLastStatusDmarcRecord
35+
from .types import DomainLastStatusMXRecord
3536
from .types import DomainLastStatusSpfRecord
3637
from .types import Domain
3738
from .types import OfferSubscription
@@ -118,6 +119,7 @@
118119
"DomainLastStatusAutoconfigState",
119120
"DomainLastStatusDkimRecord",
120121
"DomainLastStatusDmarcRecord",
122+
"DomainLastStatusMXRecord",
121123
"DomainLastStatusSpfRecord",
122124
"Domain",
123125
"OfferSubscription",

‎scaleway/scaleway/tem/v1alpha1/api.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -763,9 +763,9 @@ def get_domain_last_status(
763763
region: Optional[ScwRegion] = None,
764764
) -> DomainLastStatus:
765765
"""
766-
Display SPF and DKIM records status and potential errors.
767-
Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
768-
:param domain_id: ID of the domain to delete.
766+
Display SPF, DKIM, DMARC and MX records status and potential errors.
767+
Display SPF, DKIM, DMARC and MX records status and potential errors, including the found records to make debugging easier.
768+
:param domain_id: ID of the domain to get records status.
769769
:param region: Region to target. If none is passed will use default region from the config.
770770
:return: :class:`DomainLastStatus <DomainLastStatus>`
771771

‎scaleway/scaleway/tem/v1alpha1/marshalling.py‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
DomainLastStatusAutoconfigState,
3535
DomainLastStatusDkimRecord,
3636
DomainLastStatusDmarcRecord,
37+
DomainLastStatusMXRecord,
3738
DomainLastStatusSpfRecord,
3839
DomainLastStatus,
3940
ListBlocklistsResponse,
@@ -783,6 +784,37 @@ def unmarshal_DomainLastStatusDmarcRecord(data: Any) -> DomainLastStatusDmarcRec
783784
return DomainLastStatusDmarcRecord(**args)
784785

785786

787+
def unmarshal_DomainLastStatusMXRecord(data: Any) -> DomainLastStatusMXRecord:
788+
if not isinstance(data, dict):
789+
raise TypeError(
790+
"Unmarshalling the type 'DomainLastStatusMXRecord' failed as data isn't a dictionary."
791+
)
792+
793+
args: dict[str, Any] = {}
794+
795+
field = data.get("status", None)
796+
if field is not None:
797+
args["status"] = field
798+
else:
799+
args["status"] = DomainLastStatusRecordStatus.UNKNOWN_RECORD_STATUS
800+
801+
field = data.get("last_valid_at", None)
802+
if field is not None:
803+
args["last_valid_at"] = (
804+
parser.isoparse(field) if isinstance(field, str) else field
805+
)
806+
else:
807+
args["last_valid_at"] = None
808+
809+
field = data.get("error", None)
810+
if field is not None:
811+
args["error"] = field
812+
else:
813+
args["error"] = None
814+
815+
return DomainLastStatusMXRecord(**args)
816+
817+
786818
def unmarshal_DomainLastStatusSpfRecord(data: Any) -> DomainLastStatusSpfRecord:
787819
if not isinstance(data, dict):
788820
raise TypeError(
@@ -852,6 +884,12 @@ def unmarshal_DomainLastStatus(data: Any) -> DomainLastStatus:
852884
else:
853885
args["dmarc_record"] = None
854886

887+
field = data.get("mx_record", None)
888+
if field is not None:
889+
args["mx_record"] = unmarshal_DomainLastStatusMXRecord(field)
890+
else:
891+
args["mx_record"] = None
892+
855893
field = data.get("autoconfig_state", None)
856894
if field is not None:
857895
args["autoconfig_state"] = unmarshal_DomainLastStatusAutoconfigState(field)

‎scaleway/scaleway/tem/v1alpha1/types.py‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,24 @@ class DomainLastStatusDmarcRecord:
511511
"""
512512

513513

514+
@dataclass
515+
class DomainLastStatusMXRecord:
516+
status: DomainLastStatusRecordStatus
517+
"""
518+
Status of the MX record's configuration. This record is optional to validate a domain, but highly recommended.
519+
"""
520+
521+
last_valid_at: Optional[datetime] = None
522+
"""
523+
Time and date the MX record was last valid.
524+
"""
525+
526+
error: Optional[str] = None
527+
"""
528+
An error text displays in case the record is not valid.
529+
"""
530+
531+
514532
@dataclass
515533
class DomainLastStatusSpfRecord:
516534
status: DomainLastStatusRecordStatus
@@ -1161,6 +1179,11 @@ class DomainLastStatus:
11611179
The DMARC record verification data.
11621180
"""
11631181

1182+
mx_record: Optional[DomainLastStatusMXRecord] = None
1183+
"""
1184+
The MX record verification data.
1185+
"""
1186+
11641187
autoconfig_state: Optional[DomainLastStatusAutoconfigState] = None
11651188
"""
11661189
The verification state of domain auto-configuration.
@@ -1171,7 +1194,7 @@ class DomainLastStatus:
11711194
class GetDomainLastStatusRequest:
11721195
domain_id: str
11731196
"""
1174-
ID of the domain to delete.
1197+
ID of the domain to get records status.
11751198
"""
11761199

11771200
region: Optional[ScwRegion] = None

0 commit comments

Comments
 (0)