client_vehicles_compatibility.go

package mbz

import (
	"context"
	"encoding/json"
	"fmt"
	"io"
	"log"
	"net/http"
	"net/url"

	"github.com/way-platform/mbz-go/api/vehiclesv1"
)

// GetVehicleCompatibilityRequest is the request for [Client.GetVehicleCompatibility].
type GetVehicleCompatibilityRequest struct {
	// VIN of the vehicle to get the compatibility for.
	VIN string `json:"vin"`
}

// GetVehicleCompatibilityResponse is the response for [Client.GetVehicleCompatibility].
type GetVehicleCompatibilityResponse struct {
	// VIN of the requested vehicle.
	VIN string `json:"vin"`

	// VehicleType is the type of the requested vehicle.
	VehicleType string `json:"vehicleType,omitempty"`

	// VehicleProvidesConnectivity indicates the base compatibility to data-services for the requested vehicle.
	VehicleProvidesConnectivity bool `json:"vehicleProvidesConnectivity"`

	// Services with the service availability.
	Services []vehiclesv1.CompatibilityGenericService `json:"services"`
}

// GetVehicleCompatibility gets the compatibility of a vehicle.
func (c *Client) GetVehicleCompatibility(
	ctx context.Context,
	request *GetVehicleCompatibilityRequest,
	opts ...ClientOption,
) (_ *GetVehicleCompatibilityResponse, err error) {
	defer func() {
		if err != nil {
			err = fmt.Errorf("mbz: get vehicle compatibility: %w", err)
		}
	}()
	cfg := c.config.with(opts...)
	requestURL, err := url.JoinPath(
		c.baseURL,
		"/v1/accounts/vehicles",
		request.VIN,
		"compatibilities",
	)
	if err != nil {
		return nil, fmt.Errorf("invalid request URL: %w", err)
	}
	httpRequest, err := http.NewRequestWithContext(ctx, http.MethodGet, requestURL, nil)
	if err != nil {
		return nil, err
	}
	httpRequest.Header.Set("User-Agent", getUserAgent())
	httpResponse, err := c.httpClient(cfg).Do(httpRequest)
	if err != nil {
		return nil, err
	}
	defer func() {
		if closeErr := httpResponse.Body.Close(); closeErr != nil {
			log.Printf("mbz: failed to close response body: %v", closeErr)
		}
	}()
	if httpResponse.StatusCode != http.StatusOK {
		return nil, newResponseError(httpResponse)
	}
	data, err := io.ReadAll(httpResponse.Body)
	if err != nil {
		return nil, err
	}
	var responseBody vehiclesv1.CompatibilityResponse
	if err := json.Unmarshal(data, &responseBody); err != nil {
		return nil, err
	}
	return &GetVehicleCompatibilityResponse{
		VIN:                         responseBody.VIN,
		VehicleType:                 responseBody.VehicleType,
		VehicleProvidesConnectivity: responseBody.VehicleProvidesConnectivity,
		Services:                    responseBody.Services,
	}, nil
}