feat(billing): list discounts in v2beta1 and update list consumptions response (#418)

Author: scaleway-bot

scaleway-async/scaleway_async/billing/v2beta1/__init__.py

@@ -1,31 +1,45 @@
 # 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 DiscountDiscountMode
+from .types import DiscountFilterType
 from .types import DownloadInvoiceRequestFileType
 from .types import ExportInvoicesRequestFileType
 from .types import ExportInvoicesRequestOrderBy
 from .types import InvoiceType
 from .types import ListConsumptionsRequestOrderBy
+from .types import ListDiscountsRequestOrderBy
 from .types import ListInvoicesRequestOrderBy
 from .types import ListTaxesRequestOrderBy
+from .types import Discount
+from .types import DiscountCoupon
+from .types import DiscountFilter
 from .types import Invoice
 from .types import ListConsumptionsResponse
 from .types import ListConsumptionsResponseConsumption
+from .types import ListDiscountsResponse
 from .types import ListInvoicesResponse
 from .types import ListTaxesResponse
 from .types import ListTaxesResponseTax
 from .api import BillingV2Beta1API
 
 __all__ = [
+    "DiscountDiscountMode",
+    "DiscountFilterType",
     "DownloadInvoiceRequestFileType",
     "ExportInvoicesRequestFileType",
     "ExportInvoicesRequestOrderBy",
     "InvoiceType",
     "ListConsumptionsRequestOrderBy",
+    "ListDiscountsRequestOrderBy",
     "ListInvoicesRequestOrderBy",
     "ListTaxesRequestOrderBy",
+    "Discount",
+    "DiscountCoupon",
+    "DiscountFilter",
     "Invoice",
     "ListConsumptionsResponse",
     "ListConsumptionsResponseConsumption",
+    "ListDiscountsResponse",
     "ListInvoicesResponse",
     "ListTaxesResponse",
     "ListTaxesResponseTax",

scaleway-async/scaleway_async/billing/v2beta1/api.py

@@ -21,18 +21,22 @@
     ExportInvoicesRequestOrderBy,
     InvoiceType,
     ListConsumptionsRequestOrderBy,
+    ListDiscountsRequestOrderBy,
     ListInvoicesRequestOrderBy,
     ListTaxesRequestOrderBy,
+    Discount,
     Invoice,
     ListConsumptionsResponse,
     ListConsumptionsResponseConsumption,
+    ListDiscountsResponse,
     ListInvoicesResponse,
     ListTaxesResponse,
     ListTaxesResponseTax,
 )
 from .marshalling import (
     unmarshal_Invoice,
     unmarshal_ListConsumptionsResponse,
+    unmarshal_ListDiscountsResponse,
     unmarshal_ListInvoicesResponse,
     unmarshal_ListTaxesResponse,
 )
@@ -49,7 +53,7 @@ class BillingV2Beta1API(API):
     async def list_consumptions(
         self,
         *,
-        order_by: ListConsumptionsRequestOrderBy = ListConsumptionsRequestOrderBy.UPDATED_AT_DATE_DESC,
+        order_by: ListConsumptionsRequestOrderBy = ListConsumptionsRequestOrderBy.UPDATED_AT_DESC,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         organization_id: Optional[str] = None,
@@ -157,7 +161,7 @@ async def list_consumptions_all(
     async def list_taxes(
         self,
         *,
-        order_by: ListTaxesRequestOrderBy = ListTaxesRequestOrderBy.UPDATED_AT_DATE_DESC,
+        order_by: ListTaxesRequestOrderBy = ListTaxesRequestOrderBy.UPDATED_AT_DESC,
         page: Optional[int] = None,
         page_size: Optional[int] = None,
         organization_id: Optional[str] = None,
@@ -441,3 +445,63 @@ async def download_invoice(
         self._throw_on_error(res)
         json = res.json()
         return unmarshal_ScwFile(json) if json is not None else None
+
+    async def list_discounts(
+        self,
+        *,
+        order_by: ListDiscountsRequestOrderBy = ListDiscountsRequestOrderBy.CREATION_DATE_DESC,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        organization_id: Optional[str] = None,
+    ) -> ListDiscountsResponse:
+        """
+
+        Usage:
+        ::
+
+            result = await api.list_discounts()
+        """
+
+        res = self._request(
+            "GET",
+            f"/billing/v2beta1/discounts",
+            params={
+                "order_by": order_by,
+                "organization_id": organization_id
+                or self.client.default_organization_id,
+                "page": page,
+                "page_size": page_size or self.client.default_page_size,
+            },
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_ListDiscountsResponse(res.json())
+
+    async def list_discounts_all(
+        self,
+        *,
+        order_by: Optional[ListDiscountsRequestOrderBy] = None,
+        page: Optional[int] = None,
+        page_size: Optional[int] = None,
+        organization_id: Optional[str] = None,
+    ) -> List[Discount]:
+        """
+        :return: :class:`List[ListDiscountsResponse] <List[ListDiscountsResponse]>`
+
+        Usage:
+        ::
+
+            result = await api.list_discounts_all()
+        """
+
+        return await fetch_all_pages_async(
+            type=ListDiscountsResponse,
+            key="discounts",
+            fetcher=self.list_discounts,
+            args={
+                "order_by": order_by,
+                "page": page,
+                "page_size": page_size,
+                "organization_id": organization_id,
+            },
+        )

scaleway-async/scaleway_async/billing/v2beta1/marshalling.py

@@ -8,15 +8,99 @@
 )
 from dateutil import parser
 from .types import (
+    Discount,
+    DiscountCoupon,
+    DiscountFilter,
     Invoice,
     ListConsumptionsResponse,
     ListConsumptionsResponseConsumption,
+    ListDiscountsResponse,
     ListInvoicesResponse,
     ListTaxesResponse,
     ListTaxesResponseTax,
 )
 
 
+def unmarshal_DiscountCoupon(data: Any) -> DiscountCoupon:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("description", None)
+    args["description"] = field
+
+    return DiscountCoupon(**args)
+
+
+def unmarshal_DiscountFilter(data: Any) -> DiscountFilter:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("type", None)
+    args["type_"] = field
+
+    field = data.get("value", None)
+    args["value"] = field
+
+    return DiscountFilter(**args)
+
+
+def unmarshal_Discount(data: Any) -> Discount:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'Discount' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("coupon", None)
+    args["coupon"] = unmarshal_DiscountCoupon(field) if field is not None else None
+
+    field = data.get("creation_date", None)
+    args["creation_date"] = parser.isoparse(field) if type(field) is str else field
+
+    field = data.get("description", None)
+    args["description"] = field
+
+    field = data.get("filters", None)
+    args["filters"] = (
+        [unmarshal_DiscountFilter(v) for v in field] if field is not None else None
+    )
+
+    field = data.get("id", None)
+    args["id"] = field
+
+    field = data.get("mode", None)
+    args["mode"] = field
+
+    field = data.get("organization_id", None)
+    args["organization_id"] = field
+
+    field = data.get("start_date", None)
+    args["start_date"] = parser.isoparse(field) if type(field) is str else field
+
+    field = data.get("stop_date", None)
+    args["stop_date"] = parser.isoparse(field) if type(field) is str else field
+
+    field = data.get("value", None)
+    args["value"] = field
+
+    field = data.get("value_remaining", None)
+    args["value_remaining"] = field
+
+    field = data.get("value_used", None)
+    args["value_used"] = field
+
+    return Discount(**args)
+
+
 def unmarshal_Invoice(data: Any) -> Invoice:
     if type(data) is not dict:
         raise TypeError(
@@ -28,9 +112,6 @@ def unmarshal_Invoice(data: Any) -> Invoice:
     field = data.get("billing_period", None)
     args["billing_period"] = parser.isoparse(field) if type(field) is str else field
 
-    field = data.get("customer_name", None)
-    args["customer_name"] = field
-
     field = data.get("due_date", None)
     args["due_date"] = parser.isoparse(field) if type(field) is str else field
 
@@ -92,6 +173,9 @@ def unmarshal_ListConsumptionsResponseConsumption(
 
     args: Dict[str, Any] = {}
 
+    field = data.get("billed_quantity", None)
+    args["billed_quantity"] = field
+
     field = data.get("category_name", None)
     args["category_name"] = field
 
@@ -107,6 +191,9 @@ def unmarshal_ListConsumptionsResponseConsumption(
     field = data.get("sku", None)
     args["sku"] = field
 
+    field = data.get("unit", None)
+    args["unit"] = field
+
     field = data.get("value", None)
     args["value"] = unmarshal_Money(field) if field is not None else None
 
@@ -163,6 +250,25 @@ def unmarshal_ListConsumptionsResponse(data: Any) -> ListConsumptionsResponse:
     return ListConsumptionsResponse(**args)
 
 
+def unmarshal_ListDiscountsResponse(data: Any) -> ListDiscountsResponse:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'ListDiscountsResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("discounts", None)
+    args["discounts"] = (
+        [unmarshal_Discount(v) for v in field] if field is not None else None
+    )
+
+    field = data.get("total_count", None)
+    args["total_count"] = field
+
+    return ListDiscountsResponse(**args)
+
+
 def unmarshal_ListInvoicesResponse(data: Any) -> ListInvoicesResponse:
     if type(data) is not dict:
         raise TypeError(