feat(tem): add project settings endpoint (#664)

Author: scaleway-bot

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

@@ -11,6 +11,7 @@
 from .types import ListEmailsRequestOrderBy
 from .types import ListWebhookEventsRequestOrderBy
 from .types import ListWebhooksRequestOrderBy
+from .types import ProjectSettingsPeriodicReportFrequency
 from .types import WebhookEventStatus
 from .types import WebhookEventType
 from .types import DomainRecordsDMARC
@@ -28,6 +29,8 @@
 from .types import Domain
 from .types import WebhookEvent
 from .types import Webhook
+from .types import ProjectSettingsPeriodicReport
+from .types import UpdateProjectSettingsRequestUpdatePeriodicReport
 from .types import CancelEmailRequest
 from .types import CheckDomainRequest
 from .types import CreateDomainRequest
@@ -39,6 +42,7 @@
 from .types import GetDomainLastStatusRequest
 from .types import GetDomainRequest
 from .types import GetEmailRequest
+from .types import GetProjectSettingsRequest
 from .types import GetStatisticsRequest
 from .types import GetWebhookRequest
 from .types import ListDomainsRequest
@@ -49,9 +53,11 @@
 from .types import ListWebhookEventsResponse
 from .types import ListWebhooksRequest
 from .types import ListWebhooksResponse
+from .types import ProjectSettings
 from .types import RevokeDomainRequest
 from .types import Statistics
 from .types import UpdateDomainRequest
+from .types import UpdateProjectSettingsRequest
 from .types import UpdateWebhookRequest
 from .api import TemV1Alpha1API
 
@@ -67,6 +73,7 @@
     "ListEmailsRequestOrderBy",
     "ListWebhookEventsRequestOrderBy",
     "ListWebhooksRequestOrderBy",
+    "ProjectSettingsPeriodicReportFrequency",
     "WebhookEventStatus",
     "WebhookEventType",
     "DomainRecordsDMARC",
@@ -84,6 +91,8 @@
     "Domain",
     "WebhookEvent",
     "Webhook",
+    "ProjectSettingsPeriodicReport",
+    "UpdateProjectSettingsRequestUpdatePeriodicReport",
     "CancelEmailRequest",
     "CheckDomainRequest",
     "CreateDomainRequest",
@@ -95,6 +104,7 @@
     "GetDomainLastStatusRequest",
     "GetDomainRequest",
     "GetEmailRequest",
+    "GetProjectSettingsRequest",
     "GetStatisticsRequest",
     "GetWebhookRequest",
     "ListDomainsRequest",
@@ -105,9 +115,11 @@
     "ListWebhookEventsResponse",
     "ListWebhooksRequest",
     "ListWebhooksResponse",
+    "ProjectSettings",
     "RevokeDomainRequest",
     "Statistics",
     "UpdateDomainRequest",
+    "UpdateProjectSettingsRequest",
     "UpdateWebhookRequest",
     "TemV1Alpha1API",
 ]

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

@@ -37,8 +37,11 @@
     ListEmailsResponse,
     ListWebhookEventsResponse,
     ListWebhooksResponse,
+    ProjectSettings,
     Statistics,
     UpdateDomainRequest,
+    UpdateProjectSettingsRequest,
+    UpdateProjectSettingsRequestUpdatePeriodicReport,
     UpdateWebhookRequest,
     Webhook,
     WebhookEvent,
@@ -57,11 +60,13 @@
     unmarshal_ListEmailsResponse,
     unmarshal_ListWebhookEventsResponse,
     unmarshal_ListWebhooksResponse,
+    unmarshal_ProjectSettings,
     unmarshal_Statistics,
     marshal_CreateDomainRequest,
     marshal_CreateEmailRequest,
     marshal_CreateWebhookRequest,
     marshal_UpdateDomainRequest,
+    marshal_UpdateProjectSettingsRequest,
     marshal_UpdateWebhookRequest,
 )
 
@@ -1192,3 +1197,83 @@ async def list_webhook_events_all(
                 "domain_id": domain_id,
             },
         )
+
+    async def get_project_settings(
+        self,
+        *,
+        region: Optional[Region] = None,
+        project_id: Optional[str] = None,
+    ) -> ProjectSettings:
+        """
+        List project settings.
+        Retrieve the project settings including periodic reports.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param project_id: ID of the project.
+        :return: :class:`ProjectSettings <ProjectSettings>`
+
+        Usage:
+        ::
+
+            result = await api.get_project_settings()
+        """
+
+        param_region = validate_path_param(
+            "region", region or self.client.default_region
+        )
+        param_project_id = validate_path_param(
+            "project_id", project_id or self.client.default_project_id
+        )
+
+        res = self._request(
+            "GET",
+            f"/transactional-email/v1alpha1/regions/{param_region}/project/{param_project_id}/settings",
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_ProjectSettings(res.json())
+
+    async def update_project_settings(
+        self,
+        *,
+        region: Optional[Region] = None,
+        project_id: Optional[str] = None,
+        periodic_report: Optional[
+            UpdateProjectSettingsRequestUpdatePeriodicReport
+        ] = None,
+    ) -> ProjectSettings:
+        """
+        Update project settings.
+        Update the project settings including periodic reports.
+        :param region: Region to target. If none is passed will use default region from the config.
+        :param project_id: ID of the project.
+        :param periodic_report: Periodic report update details - all fields are optional.
+        :return: :class:`ProjectSettings <ProjectSettings>`
+
+        Usage:
+        ::
+
+            result = await api.update_project_settings()
+        """
+
+        param_region = validate_path_param(
+            "region", region or self.client.default_region
+        )
+        param_project_id = validate_path_param(
+            "project_id", project_id or self.client.default_project_id
+        )
+
+        res = self._request(
+            "PATCH",
+            f"/transactional-email/v1alpha1/regions/{param_region}/project/{param_project_id}/settings",
+            body=marshal_UpdateProjectSettingsRequest(
+                UpdateProjectSettingsRequest(
+                    region=region,
+                    project_id=project_id,
+                    periodic_report=periodic_report,
+                ),
+                self.client,
+            ),
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_ProjectSettings(res.json())

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

@@ -26,6 +26,8 @@
     WebhookEvent,
     ListWebhookEventsResponse,
     ListWebhooksResponse,
+    ProjectSettingsPeriodicReport,
+    ProjectSettings,
     Statistics,
     CreateDomainRequest,
     CreateEmailRequestAddress,
@@ -34,6 +36,8 @@
     CreateEmailRequest,
     CreateWebhookRequest,
     UpdateDomainRequest,
+    UpdateProjectSettingsRequestUpdatePeriodicReport,
+    UpdateProjectSettingsRequest,
     UpdateWebhookRequest,
 )
 
@@ -688,6 +692,50 @@ def unmarshal_ListWebhooksResponse(data: Any) -> ListWebhooksResponse:
     return ListWebhooksResponse(**args)
 
 
+def unmarshal_ProjectSettingsPeriodicReport(data: Any) -> ProjectSettingsPeriodicReport:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'ProjectSettingsPeriodicReport' 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("frequency", None)
+    if field is not None:
+        args["frequency"] = field
+
+    field = data.get("sending_hour", None)
+    if field is not None:
+        args["sending_hour"] = field
+
+    field = data.get("sending_day", None)
+    if field is not None:
+        args["sending_day"] = field
+
+    return ProjectSettingsPeriodicReport(**args)
+
+
+def unmarshal_ProjectSettings(data: Any) -> ProjectSettings:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'ProjectSettings' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("periodic_report", None)
+    if field is not None:
+        args["periodic_report"] = unmarshal_ProjectSettingsPeriodicReport(field)
+    else:
+        args["periodic_report"] = None
+
+    return ProjectSettings(**args)
+
+
 def unmarshal_Statistics(data: Any) -> Statistics:
     if not isinstance(data, dict):
         raise TypeError(
@@ -882,6 +930,43 @@ def marshal_UpdateDomainRequest(
     return output
 
 
+def marshal_UpdateProjectSettingsRequestUpdatePeriodicReport(
+    request: UpdateProjectSettingsRequestUpdatePeriodicReport,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    output: Dict[str, Any] = {}
+
+    if request.enabled is not None:
+        output["enabled"] = request.enabled
+
+    if request.frequency is not None:
+        output["frequency"] = str(request.frequency)
+
+    if request.sending_hour is not None:
+        output["sending_hour"] = request.sending_hour
+
+    if request.sending_day is not None:
+        output["sending_day"] = request.sending_day
+
+    return output
+
+
+def marshal_UpdateProjectSettingsRequest(
+    request: UpdateProjectSettingsRequest,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    output: Dict[str, Any] = {}
+
+    if request.periodic_report is not None:
+        output["periodic_report"] = (
+            marshal_UpdateProjectSettingsRequestUpdatePeriodicReport(
+                request.periodic_report, defaults
+            )
+        )
+
+    return output
+
+
 def marshal_UpdateWebhookRequest(
     request: UpdateWebhookRequest,
     defaults: ProfileDefaults,