asset_details.go

// Copyright © 2025 IN2P3 Computing Centre, IN2P3, CNRS
//
// Contributor(s): Pierre-yves FONTANIERE <pyfontan on github>, 2025
//
// This software is governed by the CeCILL license under French law and
// abiding by the rules of distribution of free software.  You can  use,
// modify and/ or redistribute the software under the terms of the CeCILL
// license as circulated by CEA, CNRS and INRIA at the following URL
// "http://www.cecill.info".
//
// As a counterpart to the access to the source code and  rights to copy,
// modify and redistribute granted by the license, users are provided only
// with a limited warranty  and the software's author,  the holder of the
// economic rights,  and the successive licensors  have only  limited
// liability.
//
// In this respect, the user's attention is drawn to the risks associated
// with loading,  using,  modifying and/or developing or reproducing the
// software by the user in light of its specific status of free software,
// that may mean  that it is complicated to manipulate,  and  that  also
// therefore means  that it is reserved for developers  and  experienced
// professionals having in-depth computer knowledge. Users are therefore
// encouraged to load and test the software's suitability as regards their
// requirements in conditions enabling the security of their systems and/or
// data to be ensured and,  more generally, to use and operate it in the
// same conditions as regards security.
//
// The fact that you are presently reading this means that you have had
// knowledge of the CeCILL license and that you accept its terms.
package daw

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
)

// AssetComponents is an asset object enhanced with the list of all its
// components.
type AssetComponents struct {
	Asset
	Components []Component `json:"components"`
}

// Component is a structure describing all components of an asset. This could
// be a power cord, a power supply, a hard drive, a fan...
type Component struct {
	ItemNumber      string `json:"itemNumber"`
	PartNumber      string `json:"partNumber"`
	PartQuantity    int    `json:"partQuantity"`
	PartDescription string `json:"partDescription"`
	ItemDescription string `json:"itemDescription"`
}

// GetAssetComponents gets asset (specified by its Tag) details from the
// DELL Techdirect Asset Warranty API.
// It uses the standard context from the client.
func (c *Client) GetAssetComponents(assetTag string) (*AssetComponents, error) {
	return c.GetAssetComponentsWithContext(c.ctx, assetTag)
}

// GetAssetComponents gets asset (specified by its Tag) details from the
// DELL Techdirect Asset Warranty API.
// It requires a context tailored to your needs.
func (c *Client) GetAssetComponentsWithContext(ctx context.Context, assetTag string) (*AssetComponents, error) {

	req, err := http.NewRequestWithContext(ctx, "GET", c.BaseURL+"/asset-components", nil)
	if err != nil {
		return nil, fmt.Errorf("creating HTTP request: %w", err)
	}

	qParams := req.URL.Query()
	qParams.Add("servicetag", assetTag)
	req.URL.RawQuery = qParams.Encode()

	res := AssetComponents{}
	if err := c.sendRequest(req, &res); err != nil {
		return nil, fmt.Errorf("sending HTTP request: %w", err)
	}

	return &res, nil
}

func (ac AssetComponents) String() string {
	jac, _ := json.MarshalIndent(ac, "", "  ")

	return fmt.Sprintf("%s\n", string(jac))
}