github.com/arduino/arduino-cloud-cli@v0.0.0-20240517070944-e7a449561083/command/dashboard/delete.go (about)

     1  // This file is part of arduino-cloud-cli.
     2  //
     3  // Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/)
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published
     7  // by the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <https://www.gnu.org/licenses/>.
    17  
    18  package dashboard
    19  
    20  import (
    21  	"context"
    22  
    23  	"github.com/arduino/arduino-cloud-cli/config"
    24  	"github.com/arduino/arduino-cloud-cli/internal/iot"
    25  )
    26  
    27  // DeleteParams contains the parameters needed to
    28  // delete a dashboard from Arduino IoT Cloud.
    29  type DeleteParams struct {
    30  	ID string
    31  }
    32  
    33  // Delete command is used to delete a dashboard
    34  // from Arduino IoT Cloud.
    35  func Delete(ctx context.Context, params *DeleteParams, cred *config.Credentials) error {
    36  	iotClient, err := iot.NewClient(cred)
    37  	if err != nil {
    38  		return err
    39  	}
    40  
    41  	return iotClient.DashboardDelete(ctx, params.ID)
    42  }