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

Author: scaleway-bot

api/billing/v2beta1/billing_sdk.go

@@ -39,6 +39,84 @@ var (
 	_ = namegenerator.GetRandomName
 )
 
+type DiscountDiscountMode string
+
+const (
+	// Unknown discount mode.
+	DiscountDiscountModeUnknownDiscountMode = DiscountDiscountMode("unknown_discount_mode")
+	// A rate discount that reduces each customer bill by the discount value percentage.
+	DiscountDiscountModeDiscountModeRate = DiscountDiscountMode("discount_mode_rate")
+	// A value discount that reduces the amount of the customer bill by the discount value.
+	DiscountDiscountModeDiscountModeValue = DiscountDiscountMode("discount_mode_value")
+	// A fixed sum to be deducted from the user's bills.
+	DiscountDiscountModeDiscountModeSplittable = DiscountDiscountMode("discount_mode_splittable")
+)
+
+func (enum DiscountDiscountMode) String() string {
+	if enum == "" {
+		// return default value if empty
+		return "unknown_discount_mode"
+	}
+	return string(enum)
+}
+
+func (enum DiscountDiscountMode) MarshalJSON() ([]byte, error) {
+	return []byte(fmt.Sprintf(`"%s"`, enum)), nil
+}
+
+func (enum *DiscountDiscountMode) UnmarshalJSON(data []byte) error {
+	tmp := ""
+
+	if err := json.Unmarshal(data, &tmp); err != nil {
+		return err
+	}
+
+	*enum = DiscountDiscountMode(DiscountDiscountMode(tmp).String())
+	return nil
+}
+
+type DiscountFilterType string
+
+const (
+	// Unknown filter type.
+	DiscountFilterTypeUnknownType = DiscountFilterType("unknown_type")
+	// Product category, such as Compute, Network, Observability.
+	DiscountFilterTypeCategoryName = DiscountFilterType("category_name")
+	// Products within the Product category. For example, VPC, Private Networks, and Public Gateways are products in the Network category.
+	DiscountFilterTypeProductName = DiscountFilterType("product_name")
+	// The range of a product. For example, `Production Optimized` or `Cost Optimized` for an `instance` product of the `compute` category.
+	DiscountFilterTypeProductRange = DiscountFilterType("product_range")
+	// Identifies the reference based on category, product, range, size, region, and zone. It can sometimes include different product options, such as licenses and monthly payments.
+	DiscountFilterTypeResourceName = DiscountFilterType("resource_name")
+	// Region name like "FR-PAR", "NL-AMS", "PL-WAW".
+	DiscountFilterTypeRegion = DiscountFilterType("region")
+	// Zone name like "FR-PAR-1", "FR-PAR-2", "FR-PAR-3".
+	DiscountFilterTypeZone = DiscountFilterType("zone")
+)
+
+func (enum DiscountFilterType) String() string {
+	if enum == "" {
+		// return default value if empty
+		return "unknown_type"
+	}
+	return string(enum)
+}
+
+func (enum DiscountFilterType) MarshalJSON() ([]byte, error) {
+	return []byte(fmt.Sprintf(`"%s"`, enum)), nil
+}
+
+func (enum *DiscountFilterType) UnmarshalJSON(data []byte) error {
+	tmp := ""
+
+	if err := json.Unmarshal(data, &tmp); err != nil {
+		return err
+	}
+
+	*enum = DiscountFilterType(DiscountFilterType(tmp).String())
+	return nil
+}
+
 type DownloadInvoiceRequestFileType string
 
 const (
@@ -174,9 +252,9 @@ type ListConsumptionsRequestOrderBy string
 
 const (
 	// Order consumptions by update date (descending chronological order).
-	ListConsumptionsRequestOrderByUpdatedAtDateDesc = ListConsumptionsRequestOrderBy("updated_at_date_desc")
+	ListConsumptionsRequestOrderByUpdatedAtDesc = ListConsumptionsRequestOrderBy("updated_at_desc")
 	// Order consumptions by update date (ascending chronological order).
-	ListConsumptionsRequestOrderByUpdatedAtDateAsc = ListConsumptionsRequestOrderBy("updated_at_date_asc")
+	ListConsumptionsRequestOrderByUpdatedAtAsc = ListConsumptionsRequestOrderBy("updated_at_asc")
 	// Order consumptions by category name (descending alphabetical order).
 	ListConsumptionsRequestOrderByCategoryNameDesc = ListConsumptionsRequestOrderBy("category_name_desc")
 	// Order consumptions by category name (ascending alphabetical order).
@@ -186,7 +264,7 @@ const (
 func (enum ListConsumptionsRequestOrderBy) String() string {
 	if enum == "" {
 		// return default value if empty
-		return "updated_at_date_desc"
+		return "updated_at_desc"
 	}
 	return string(enum)
 }
@@ -206,6 +284,38 @@ func (enum *ListConsumptionsRequestOrderBy) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+type ListDiscountsRequestOrderBy string
+
+const (
+	// Order discounts by creation date (descending chronological order).
+	ListDiscountsRequestOrderByCreationDateDesc = ListDiscountsRequestOrderBy("creation_date_desc")
+	// Order discounts by creation date (ascending chronological order).
+	ListDiscountsRequestOrderByCreationDateAsc = ListDiscountsRequestOrderBy("creation_date_asc")
+)
+
+func (enum ListDiscountsRequestOrderBy) String() string {
+	if enum == "" {
+		// return default value if empty
+		return "creation_date_desc"
+	}
+	return string(enum)
+}
+
+func (enum ListDiscountsRequestOrderBy) MarshalJSON() ([]byte, error) {
+	return []byte(fmt.Sprintf(`"%s"`, enum)), nil
+}
+
+func (enum *ListDiscountsRequestOrderBy) UnmarshalJSON(data []byte) error {
+	tmp := ""
+
+	if err := json.Unmarshal(data, &tmp); err != nil {
+		return err
+	}
+
+	*enum = ListDiscountsRequestOrderBy(ListDiscountsRequestOrderBy(tmp).String())
+	return nil
+}
+
 type ListInvoicesRequestOrderBy string
 
 const (
@@ -252,9 +362,9 @@ type ListTaxesRequestOrderBy string
 
 const (
 	// Order consumptions by update date (descending chronological order).
-	ListTaxesRequestOrderByUpdatedAtDateDesc = ListTaxesRequestOrderBy("updated_at_date_desc")
+	ListTaxesRequestOrderByUpdatedAtDesc = ListTaxesRequestOrderBy("updated_at_desc")
 	// Order consumptions by update date (ascending chronological order).
-	ListTaxesRequestOrderByUpdatedAtDateAsc = ListTaxesRequestOrderBy("updated_at_date_asc")
+	ListTaxesRequestOrderByUpdatedAtAsc = ListTaxesRequestOrderBy("updated_at_asc")
 	// Order consumptions by category name (descending alphabetical order).
 	ListTaxesRequestOrderByCategoryNameDesc = ListTaxesRequestOrderBy("category_name_desc")
 	// Order consumptions by category name (ascending alphabetical order).
@@ -264,7 +374,7 @@ const (
 func (enum ListTaxesRequestOrderBy) String() string {
 	if enum == "" {
 		// return default value if empty
-		return "updated_at_date_desc"
+		return "updated_at_desc"
 	}
 	return string(enum)
 }
@@ -284,6 +394,22 @@ func (enum *ListTaxesRequestOrderBy) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+// DiscountCoupon: discount coupon.
+type DiscountCoupon struct {
+	// Description: the description of the coupon.
+	Description *string `json:"description"`
+}
+
+// DiscountFilter: discount filter.
+type DiscountFilter struct {
+	// Type: type of the filter (category name, product name, product range, resource name, region or zone).
+	// Default value: unknown_type
+	Type DiscountFilterType `json:"type"`
+
+	// Value: value of filter.
+	Value string `json:"value"`
+}
+
 // ListConsumptionsResponseConsumption: list consumptions response consumption.
 type ListConsumptionsResponseConsumption struct {
 	// Value: monetary value of the consumption.
@@ -303,6 +429,52 @@ type ListConsumptionsResponseConsumption struct {
 
 	// CategoryName: name of consumption category.
 	CategoryName string `json:"category_name"`
+
+	// Unit: unit of consumed quantity.
+	Unit string `json:"unit"`
+
+	// BilledQuantity: consumed quantity.
+	BilledQuantity string `json:"billed_quantity"`
+}
+
+// Discount: discount.
+type Discount struct {
+	// ID: the ID of the discount.
+	ID string `json:"id"`
+
+	// CreationDate: the creation date of the discount.
+	CreationDate *time.Time `json:"creation_date"`
+
+	// OrganizationID: the organization ID of the discount.
+	OrganizationID string `json:"organization_id"`
+
+	// Description: the description of the discount.
+	Description string `json:"description"`
+
+	// Value: the initial value of the discount.
+	Value float64 `json:"value"`
+
+	// ValueUsed: the value indicating how much of the discount has been used.
+	ValueUsed float64 `json:"value_used"`
+
+	// ValueRemaining: the remaining value of the discount.
+	ValueRemaining float64 `json:"value_remaining"`
+
+	// Mode: the mode of the discount.
+	// Default value: unknown_discount_mode
+	Mode DiscountDiscountMode `json:"mode"`
+
+	// StartDate: the start date of the discount.
+	StartDate *time.Time `json:"start_date"`
+
+	// StopDate: the stop date of the discount.
+	StopDate *time.Time `json:"stop_date"`
+
+	// Coupon: the description of the coupon.
+	Coupon *DiscountCoupon `json:"coupon"`
+
+	// Filters: list of the discount scopes.
+	Filters []*DiscountFilter `json:"filters"`
 }
 
 // Invoice: invoice.
@@ -353,10 +525,8 @@ type Invoice struct {
 	// Number: invoice number.
 	Number int32 `json:"number"`
 
+	// SellerName: the name of the seller (Scaleway).
 	SellerName string `json:"seller_name"`
-
-	// CustomerName: customer name associated to this organization.
-	CustomerName string `json:"customer_name"`
 }
 
 // ListTaxesResponseTax: list taxes response tax.
@@ -423,7 +593,7 @@ type GetInvoiceRequest struct {
 // ListConsumptionsRequest: list consumptions request.
 type ListConsumptionsRequest struct {
 	// OrderBy: order consumptions list in the response by their update date.
-	// Default value: updated_at_date_desc
+	// Default value: updated_at_desc
 	OrderBy ListConsumptionsRequestOrderBy `json:"-"`
 
 	// Page: positive integer to choose the page to return.
@@ -481,6 +651,50 @@ func (r *ListConsumptionsResponse) UnsafeAppend(res interface{}) (uint64, error)
 	return uint64(len(results.Consumptions)), nil
 }
 
+// ListDiscountsRequest: list discounts request.
+type ListDiscountsRequest struct {
+	// OrderBy: order discounts in the response by their description.
+	// Default value: creation_date_desc
+	OrderBy ListDiscountsRequestOrderBy `json:"-"`
+
+	// Page: positive integer to choose the page to return.
+	Page *int32 `json:"-"`
+
+	// PageSize: positive integer lower or equal to 100 to select the number of items to return.
+	PageSize *uint32 `json:"-"`
+
+	// OrganizationID: ID of the organization.
+	OrganizationID *string `json:"-"`
+}
+
+// ListDiscountsResponse: list discounts response.
+type ListDiscountsResponse struct {
+	// TotalCount: total number of discounts.
+	TotalCount uint64 `json:"total_count"`
+
+	// Discounts: paginated returned discounts.
+	Discounts []*Discount `json:"discounts"`
+}
+
+// UnsafeGetTotalCount should not be used
+// Internal usage only
+func (r *ListDiscountsResponse) UnsafeGetTotalCount() uint64 {
+	return r.TotalCount
+}
+
+// UnsafeAppend should not be used
+// Internal usage only
+func (r *ListDiscountsResponse) UnsafeAppend(res interface{}) (uint64, error) {
+	results, ok := res.(*ListDiscountsResponse)
+	if !ok {
+		return 0, errors.New("%T type cannot be appended to type %T", res, r)
+	}
+
+	r.Discounts = append(r.Discounts, results.Discounts...)
+	r.TotalCount += uint64(len(results.Discounts))
+	return uint64(len(results.Discounts)), nil
+}
+
 // ListInvoicesRequest: list invoices request.
 type ListInvoicesRequest struct {
 	// OrganizationID: organization ID. If specified, only invoices from this Organization will be returned.
@@ -538,7 +752,7 @@ func (r *ListInvoicesResponse) UnsafeAppend(res interface{}) (uint64, error) {
 // ListTaxesRequest: list taxes request.
 type ListTaxesRequest struct {
 	// OrderBy: order consumed taxes list in the response by their update date.
-	// Default value: updated_at_date_desc
+	// Default value: updated_at_desc
 	OrderBy ListTaxesRequestOrderBy `json:"-"`
 
 	// Page: page number.
@@ -790,3 +1004,33 @@ func (s *API) DownloadInvoice(req *DownloadInvoiceRequest, opts ...scw.RequestOp
 	}
 	return &resp, nil
 }
+
+// ListDiscounts:
+func (s *API) ListDiscounts(req *ListDiscountsRequest, opts ...scw.RequestOption) (*ListDiscountsResponse, error) {
+	var err error
+
+	defaultPageSize, exist := s.client.GetDefaultPageSize()
+	if (req.PageSize == nil || *req.PageSize == 0) && exist {
+		req.PageSize = &defaultPageSize
+	}
+
+	query := url.Values{}
+	parameter.AddToQuery(query, "order_by", req.OrderBy)
+	parameter.AddToQuery(query, "page", req.Page)
+	parameter.AddToQuery(query, "page_size", req.PageSize)
+	parameter.AddToQuery(query, "organization_id", req.OrganizationID)
+
+	scwReq := &scw.ScalewayRequest{
+		Method: "GET",
+		Path:   "/billing/v2beta1/discounts",
+		Query:  query,
+	}
+
+	var resp ListDiscountsResponse
+
+	err = s.client.Do(scwReq, &resp, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return &resp, nil
+}