feat(edge_services): add GetCurrentBilling endpoint (#686)

Co-authored-by: Laure-di <62625835+Laure-di@users.noreply.github.com>

Author: scaleway-bot

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

@@ -50,6 +50,8 @@
 from .types import DeletePipelineRequest
 from .types import DeleteTLSStageRequest
 from .types import GetBackendStageRequest
+from .types import GetBillingRequest
+from .types import GetBillingResponse
 from .types import GetCacheStageRequest
 from .types import GetCurrentPlanRequest
 from .types import GetDNSStageRequest
@@ -129,6 +131,8 @@
     "DeletePipelineRequest",
     "DeleteTLSStageRequest",
     "GetBackendStageRequest",
+    "GetBillingRequest",
+    "GetBillingResponse",
     "GetCacheStageRequest",
     "GetCurrentPlanRequest",
     "GetDNSStageRequest",

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

@@ -34,6 +34,7 @@
     CreatePurgeRequestRequest,
     CreateTLSStageRequest,
     DNSStage,
+    GetBillingResponse,
     ListBackendStagesResponse,
     ListCacheStagesResponse,
     ListDNSStagesResponse,
@@ -71,6 +72,7 @@
     unmarshal_CheckDomainResponse,
     unmarshal_CheckLbOriginResponse,
     unmarshal_CheckPEMChainResponse,
+    unmarshal_GetBillingResponse,
     unmarshal_ListBackendStagesResponse,
     unmarshal_ListCacheStagesResponse,
     unmarshal_ListDNSStagesResponse,
@@ -1710,3 +1712,31 @@ async def delete_current_plan(
         )
 
         self._throw_on_error(res)
+
+    async def get_billing(
+        self,
+        *,
+        project_id: Optional[str] = None,
+    ) -> GetBillingResponse:
+        """
+        Gives information on current edge-services subscription plan and used resources with associated price.
+        :param project_id:
+        :return: :class:`GetBillingResponse <GetBillingResponse>`
+
+        Usage:
+        ::
+
+            result = await api.get_billing()
+        """
+
+        param_project_id = validate_path_param(
+            "project_id", project_id or self.client.default_project_id
+        )
+
+        res = self._request(
+            "GET",
+            f"/edge-services/v1alpha1/billing/{param_project_id}",
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_GetBillingResponse(res.json())

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

@@ -5,6 +5,9 @@
 from dateutil import parser
 
 from scaleway_core.profile import ProfileDefaults
+from scaleway_core.bridge import (
+    unmarshal_Money,
+)
 from scaleway_core.utils import (
     OneOfPossibility,
     resolve_one_of,
@@ -24,11 +27,12 @@
     CheckDomainResponse,
     CheckLbOriginResponse,
     CheckPEMChainResponse,
+    PlanDetails,
+    GetBillingResponse,
     ListBackendStagesResponse,
     ListCacheStagesResponse,
     ListDNSStagesResponse,
     ListPipelinesResponse,
-    PlanDetails,
     ListPlansResponse,
     ListPurgeRequestsResponse,
     ListTLSStagesResponse,
@@ -563,6 +567,82 @@ def unmarshal_CheckPEMChainResponse(data: Any) -> CheckPEMChainResponse:
     return CheckPEMChainResponse(**args)
 
 
+def unmarshal_PlanDetails(data: Any) -> PlanDetails:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("plan_name", None)
+    if field is not None:
+        args["plan_name"] = field
+
+    field = data.get("package_gb", None)
+    if field is not None:
+        args["package_gb"] = field
+
+    field = data.get("pipeline_limit", None)
+    if field is not None:
+        args["pipeline_limit"] = field
+
+    return PlanDetails(**args)
+
+
+def unmarshal_GetBillingResponse(data: Any) -> GetBillingResponse:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'GetBillingResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("pipeline_number", None)
+    if field is not None:
+        args["pipeline_number"] = field
+
+    field = data.get("current_plan_cache_usage", None)
+    if field is not None:
+        args["current_plan_cache_usage"] = field
+
+    field = data.get("extra_cache_usage", None)
+    if field is not None:
+        args["extra_cache_usage"] = field
+
+    field = data.get("current_plan", None)
+    if field is not None:
+        args["current_plan"] = unmarshal_PlanDetails(field)
+    else:
+        args["current_plan"] = None
+
+    field = data.get("plan_cost", None)
+    if field is not None:
+        args["plan_cost"] = unmarshal_Money(field)
+    else:
+        args["plan_cost"] = None
+
+    field = data.get("extra_pipelines_cost", None)
+    if field is not None:
+        args["extra_pipelines_cost"] = unmarshal_Money(field)
+    else:
+        args["extra_pipelines_cost"] = None
+
+    field = data.get("extra_cache_cost", None)
+    if field is not None:
+        args["extra_cache_cost"] = unmarshal_Money(field)
+    else:
+        args["extra_cache_cost"] = None
+
+    field = data.get("total_cost", None)
+    if field is not None:
+        args["total_cost"] = unmarshal_Money(field)
+    else:
+        args["total_cost"] = None
+
+    return GetBillingResponse(**args)
+
+
 def unmarshal_ListBackendStagesResponse(data: Any) -> ListBackendStagesResponse:
     if not isinstance(data, dict):
         raise TypeError(
@@ -647,29 +727,6 @@ def unmarshal_ListPipelinesResponse(data: Any) -> ListPipelinesResponse:
     return ListPipelinesResponse(**args)
 
 
-def unmarshal_PlanDetails(data: Any) -> PlanDetails:
-    if not isinstance(data, dict):
-        raise TypeError(
-            "Unmarshalling the type 'PlanDetails' failed as data isn't a dictionary."
-        )
-
-    args: Dict[str, Any] = {}
-
-    field = data.get("plan_name", None)
-    if field is not None:
-        args["plan_name"] = field
-
-    field = data.get("package_gb", None)
-    if field is not None:
-        args["package_gb"] = field
-
-    field = data.get("pipeline_limit", None)
-    if field is not None:
-        args["pipeline_limit"] = field
-
-    return PlanDetails(**args)
-
-
 def unmarshal_ListPlansResponse(data: Any) -> ListPlansResponse:
     if not isinstance(data, dict):
         raise TypeError(

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

@@ -8,6 +8,7 @@
 from typing import List, Optional
 
 from scaleway_core.bridge import (
+    Money,
     Region,
     Zone,
 )
@@ -472,10 +473,19 @@ class CheckPEMChainRequestSecretChain:
 @dataclass
 class PlanDetails:
     plan_name: PlanName
+    """
+    Subscription plan name.
+    """
 
     package_gb: int
+    """
+    Amount of egress data from cache included in subscription plan.
+    """
 
     pipeline_limit: int
+    """
+    Number of pipeline included in subscription plan.
+    """
 
 
 @dataclass
@@ -713,6 +723,54 @@ class GetBackendStageRequest:
     """
 
 
+@dataclass
+class GetBillingRequest:
+    project_id: Optional[str]
+
+
+@dataclass
+class GetBillingResponse:
+    pipeline_number: int
+    """
+    Total number of pipeline currently configured.
+    """
+
+    current_plan_cache_usage: int
+    """
+    Total amount of data egressed from cache in current subscription plan.
+    """
+
+    extra_cache_usage: int
+    """
+    Total amount of data egressed from cache not included in the plans.
+    """
+
+    current_plan: Optional[PlanDetails]
+    """
+    Information on the current edge-service subscription plan.
+    """
+
+    plan_cost: Optional[Money]
+    """
+    Price of the current subscription plan.
+    """
+
+    extra_pipelines_cost: Optional[Money]
+    """
+    Cost to date of the pipelines not included in the plans.
+    """
+
+    extra_cache_cost: Optional[Money]
+    """
+    Cost to date of the data egressed from cache not included in the plans.
+    """
+
+    total_cost: Optional[Money]
+    """
+    Total cost to date of edge-service product for the month including current plan, previous plans, extra pipelines and extra egress cache data.
+    """
+
+
 @dataclass
 class GetCacheStageRequest:
     cache_stage_id: str

scaleway/scaleway/edge_services/v1alpha1/__init__.py

@@ -50,6 +50,8 @@
 from .types import DeletePipelineRequest
 from .types import DeleteTLSStageRequest
 from .types import GetBackendStageRequest
+from .types import GetBillingRequest
+from .types import GetBillingResponse
 from .types import GetCacheStageRequest
 from .types import GetCurrentPlanRequest
 from .types import GetDNSStageRequest
@@ -129,6 +131,8 @@
     "DeletePipelineRequest",
     "DeleteTLSStageRequest",
     "GetBackendStageRequest",
+    "GetBillingRequest",
+    "GetBillingResponse",
     "GetCacheStageRequest",
     "GetCurrentPlanRequest",
     "GetDNSStageRequest",

scaleway/scaleway/edge_services/v1alpha1/api.py

@@ -34,6 +34,7 @@
     CreatePurgeRequestRequest,
     CreateTLSStageRequest,
     DNSStage,
+    GetBillingResponse,
     ListBackendStagesResponse,
     ListCacheStagesResponse,
     ListDNSStagesResponse,
@@ -71,6 +72,7 @@
     unmarshal_CheckDomainResponse,
     unmarshal_CheckLbOriginResponse,
     unmarshal_CheckPEMChainResponse,
+    unmarshal_GetBillingResponse,
     unmarshal_ListBackendStagesResponse,
     unmarshal_ListCacheStagesResponse,
     unmarshal_ListDNSStagesResponse,
@@ -1706,3 +1708,31 @@ def delete_current_plan(
         )
 
         self._throw_on_error(res)
+
+    def get_billing(
+        self,
+        *,
+        project_id: Optional[str] = None,
+    ) -> GetBillingResponse:
+        """
+        Gives information on current edge-services subscription plan and used resources with associated price.
+        :param project_id:
+        :return: :class:`GetBillingResponse <GetBillingResponse>`
+
+        Usage:
+        ::
+
+            result = api.get_billing()
+        """
+
+        param_project_id = validate_path_param(
+            "project_id", project_id or self.client.default_project_id
+        )
+
+        res = self._request(
+            "GET",
+            f"/edge-services/v1alpha1/billing/{param_project_id}",
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_GetBillingResponse(res.json())