feat(billing): remove v2alpha1 and add download & export custom commands (#3677)

Author: yfodil

cmd/scw/testdata/test-all-usage-billing-invoice-download-usage.golden

@@ -6,8 +6,10 @@ USAGE:
   scw billing invoice download <invoice-id ...> [arg=value ...]
 
 ARGS:
-  invoice-id    Invoice ID
-  [file-type]   File type. PDF by default (pdf)
+  invoice-id              Invoice ID
+  [file-path=./]          Wanted file path
+  [file-type=pdf]         Wanted file extension
+  [force-replace=false]   Force file replacement
 
 FLAGS:
   -h, --help   help for download

cmd/scw/testdata/test-all-usage-billing-invoice-export-usage.golden

@@ -6,14 +6,13 @@ USAGE:
   scw billing invoice export [arg=value ...]
 
 ARGS:
+  [organization-id]               Organization ID. If specified, only invoices from this Organization will be returned
   [billing-period-start-after]    Return only invoice with start date greater than billing_period_start
   [billing-period-start-before]   Return only invoice with start date less than billing_period_start
-  [invoice-type]                  Invoice type. It can either be `periodic` or `purchase` (unknown_type | periodic | purchase)
-  [page]                          Page number
-  [page-size=20]                  Positive integer lower or equal to 100 to select the number of items to return
-  [order-by]                      How invoices are ordered in the response (invoice_number_desc | invoice_number_asc | start_date_desc | start_date_asc | issued_date_desc | issued_date_asc | due_date_desc | due_date_asc | total_untaxed_desc | total_untaxed_asc | total_taxed_desc | total_taxed_asc | invoice_type_desc | invoice_type_asc)
-  [file-type=CSV]                 File format for exporting the invoice list (csv)
-  [organization-id]               Organization ID. If specified, only invoices from this Organization will be returned
+  [invoice-type]                  Invoice type. It can either be `periodic` or `purchase`
+  [file-path=./]                  Wanted file path
+  [file-type=csv]                 Wanted file extension
+  [force-replace=false]           Force file replacement
 
 FLAGS:
   -h, --help   help for export

docs/commands/billing.md

@@ -109,7 +109,9 @@ scw billing invoice download <invoice-id ...> [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | invoice-id | Required | Invoice ID |
-| file-type | One of: `pdf` | File type. PDF by default |
+| file-path | Default: `./` | Wanted file path |
+| file-type | Default: `pdf` | Wanted file extension |
+| force-replace | Default: `false` | Force file replacement |
 
 
 
@@ -128,14 +130,13 @@ scw billing invoice export [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
+| organization-id |  | Organization ID. If specified, only invoices from this Organization will be returned |
 | billing-period-start-after |  | Return only invoice with start date greater than billing_period_start |
 | billing-period-start-before |  | Return only invoice with start date less than billing_period_start |
-| invoice-type | One of: `unknown_type`, `periodic`, `purchase` | Invoice type. It can either be `periodic` or `purchase` |
-| page |  | Page number |
-| page-size | Default: `20` | Positive integer lower or equal to 100 to select the number of items to return |
-| order-by | One of: `invoice_number_desc`, `invoice_number_asc`, `start_date_desc`, `start_date_asc`, `issued_date_desc`, `issued_date_asc`, `due_date_desc`, `due_date_asc`, `total_untaxed_desc`, `total_untaxed_asc`, `total_taxed_desc`, `total_taxed_asc`, `invoice_type_desc`, `invoice_type_asc` | How invoices are ordered in the response |
-| file-type | Default: `CSV`<br />One of: `csv` | File format for exporting the invoice list |
-| organization-id |  | Organization ID. If specified, only invoices from this Organization will be returned |
+| invoice-type |  | Invoice type. It can either be `periodic` or `purchase` |
+| file-path | Default: `./` | Wanted file path |
+| file-type | Default: `csv` | Wanted file extension |
+| force-replace | Default: `false` | Force file replacement |
 
 
 

internal/namespaces/billing/v2alpha1/billing_cli.go

@@ -1,11 +1,24 @@
 package billing
 
 import (
+	"github.com/fatih/color"
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	"github.com/scaleway/scaleway-cli/v2/internal/human"
+	billing "github.com/scaleway/scaleway-sdk-go/api/billing/v2beta1"
+)
+
+var (
+	invoiceTypeMarshalSpecs = human.EnumMarshalSpecs{
+		billing.DownloadInvoiceRequestFileTypePdf: &human.EnumMarshalSpec{Attribute: color.FgHiBlue, Value: "pdf"},
+	}
 )
 
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	human.RegisterMarshalerFunc(billing.DownloadInvoiceRequestFileType("pdf"), human.EnumMarshalFunc(invoiceTypeMarshalSpecs))
+	cmds.MustFind("billing", "invoice", "download").Override(invoiceDownloadBuilder)
+	cmds.MustFind("billing", "invoice", "export").Override(invoiceExportBuilder)
+
 	return cmds
 }

internal/namespaces/billing/v2alpha1/custom.go

@@ -14,11 +14,7 @@ import (
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
 	"github.com/scaleway/scaleway-cli/v2/internal/interactive"
 	"github.com/scaleway/scaleway-cli/v2/internal/terminal"
-	billing "github.com/scaleway/scaleway-sdk-go/api/billing/v2alpha1"
-)
-
-const (
-	invoiceDefaultPrefix = "scaleway-invoice"
+	billing "github.com/scaleway/scaleway-sdk-go/api/billing/v2beta1"
 )
 
 type billingDownloadRequest struct {
@@ -28,19 +24,15 @@ type billingDownloadRequest struct {
 	ForceReplace bool
 }
 
-func fileNameWithoutExtTrimSuffix(fileName string) string {
-	return strings.TrimSuffix(fileName, filepath.Ext(fileName))
-}
-
-func buildDownloadCommand(command *core.Command) *core.Command {
+func invoiceDownloadBuilder(command *core.Command) *core.Command {
 	command.ArgsType = reflect.TypeOf(billingDownloadRequest{})
 	command.ArgSpecs = core.ArgSpecs{
 		{
 			Name:       "invoice-id",
 			Short:      `Invoice ID`,
 			Required:   true,
 			Deprecated: false,
-			Positional: false,
+			Positional: true,
 		},
 		{
 			Name:       "file-path",
@@ -90,7 +82,7 @@ func buildDownloadCommand(command *core.Command) *core.Command {
 		dir, file := getDirFile(args.FilePath)
 		if len(file) > 0 {
 			fileExtension := filepath.Ext(file)
-			if extensionOnFile := checkInvoiceExt(fileExtension); !extensionOnFile {
+			if extensionOnFile := checkDownloadInvoiceExt(fileExtension); !extensionOnFile {
 				return fmt.Errorf("file has not supported extension")
 			}
 		}
@@ -144,21 +136,7 @@ func buildDownloadCommand(command *core.Command) *core.Command {
 	return command
 }
 
-func getDirFile(filePath string) (string, string) {
-	dir := "."
-	dirTmp, file := filepath.Split(filePath)
-	if len(dirTmp) > 0 {
-		dir = dirTmp
-	}
-
-	if file == "." {
-		file = ""
-	}
-
-	return dir, file
-}
-
-func addExt(fileName, contentType string) string {
+func addDownloadExt(fileName, contentType string) string {
 	switch contentType {
 	case "application/pdf":
 		fileName = fmt.Sprintf("%s.pdf", fileName)
@@ -167,7 +145,7 @@ func addExt(fileName, contentType string) string {
 	return fileName
 }
 
-func checkInvoiceExt(ext string) bool {
+func checkDownloadInvoiceExt(ext string) bool {
 	switch ext {
 	case ".pdf":
 		return true
@@ -211,7 +189,7 @@ func billingDownloadRun(ctx context.Context, argsI interface{}) (interface{}, er
 		}
 	}
 	// add supported extension
-	fileName = addExt(fileName, resp.ContentType)
+	fileName = addDownloadExt(fileName, resp.ContentType)
 
 	fileOutput, err := os.Create(fileName)
 	if err != nil {