classicapi_classes.go

// classicapi_classes.go
// Jamf Pro Classic Api - Classes
// api reference: https://developer.jamf.com/jamf-pro/reference/classes
// Classic API requires the structs to support an XML data structure.

/*
Shared Resources in this Endpoint:
- SharedResourceSite
*/

package jamfpro

import (
	"encoding/xml"
	"fmt"
)

// Constants for the classes endpoint
const uriClasses = "/JSSResource/classes"

// List

// ResponseClassesList represents the XML response for a list of classes.
type ResponseClassesList struct {
	Size    int             `xml:"size"`
	Classes []ClassListItem `xml:"class"`
}

// ClassItem represents a single class item in the list.
type ClassListItem struct {
	ID          int    `xml:"id"`
	Name        string `xml:"name"`
	Description string `xml:"description"`
}

// Resource

type ResourceClass struct {
	ID                  int                              `xml:"id,omitempty"`
	Source              string                           `xml:"source,omitempty"`
	Name                string                           `xml:"name,omitempty"`
	Description         string                           `xml:"description,omitempty"`
	Site                SharedResourceSite               `xml:"site"`
	MobileDeviceGroup   ClassSubsetMobileDeviceGroup     `xml:"mobile_device_group,omitempty"`
	Students            []ClassSubsetStudent             `xml:"students>student"`
	Teachers            []ClassSubsetTeacher             `xml:"teachers>teacher,omitempty"`
	TeacherIDs          []ClassSubsetTeacherIDs          `xml:"teacher_ids>id,omitempty"`
	StudentGroupIDs     []ClassSubsetStudentGroupIDs     `xml:"student_group_ids>id"`
	TeacherGroupIDs     []ClassSubsetTeacherGroupIDs     `xml:"teacher_group_ids>id"`
	MobileDevices       []ClassSubsetMobileDevices       `xml:"mobile_devices>mobile_device"`
	MobileDeviceGroupID []ClassSubsetMobileDeviceGroupID `xml:"mobile_device_group_id>id,omitempty"`
	MeetingTimes        ClassContainerMeetingTimes       `xml:"meeting_times,omitempty"`
	AppleTVs            []ClassSubsetAppleTVs            `xml:"apple_tvs>apple_tv,omitempty"`
}

// Subsets & Containers

// Mobile Device Group

type ClassSubsetMobileDeviceGroup struct {
	ID   int    `xml:"id,omitempty"`
	Name string `xml:"name,omitempty"`
}

// Mobile Devices

type ClassSubsetMobileDevices struct {
	Name           string `xml:"name,omitempty"`
	UDID           string `xml:"udid,omitempty"`
	WifiMacAddress string `xml:"wifi_mac_address,omitempty"`
}

// Mobile Device Group ID

type ClassSubsetMobileDeviceGroupID struct {
	ID int `xml:"id,omitempty"`
}

// Student

type ClassSubsetStudent struct {
	Student string `xml:"student,omitempty"`
}

// Teacher

type ClassSubsetTeacher struct {
	Teacher string `xml:"teacher,omitempty"`
}

// Teacher IDs

type ClassSubsetTeacherIDs struct {
	ID int `xml:"id,omitempty"`
}

// Student Group IDs

type ClassSubsetStudentGroupIDs struct {
	ID int `xml:"id,omitempty"`
}

// Teacher Group IDs

type ClassSubsetTeacherGroupIDs struct {
	ID int `xml:"id,omitempty"`
}

// Meeting Times

type ClassContainerMeetingTimes struct {
	MeetingTime ClassSubsetMeetingTime `xml:"meeting_time,omitempty"`
}

type ClassSubsetMeetingTime struct {
	Days      string `xml:"days,omitempty"`
	StartTime int    `xml:"start_time,omitempty"`
	EndTime   int    `xml:"end_time,omitempty"`
}

// Apple TVs

type ClassSubsetAppleTVs struct {
	Name            string `xml:"name,omitempty"`
	UDID            string `xml:"udid,omitempty"`
	WifiMacAddress  string `xml:"wifi_mac_address,omitempty"`
	DeviceID        string `xml:"device_id,omitempty"`
	AirplayPassword string `xml:"airplay_password,omitempty"`
}

// CRUD

// GetClasses gets a list of all classes.
func (c *Client) GetClasses() (*ResponseClassesList, error) {
	endpoint := uriClasses

	var classes ResponseClassesList
	resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &classes)
	if err != nil {
		return nil, fmt.Errorf(errMsgFailedGet, "classes", err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return &classes, nil
}

// GetClassesByID retrieves a class by its ID.
func (c *Client) GetClassByID(id int) (*ResourceClass, error) {
	endpoint := fmt.Sprintf("%s/id/%d", uriClasses, id)

	var class ResourceClass
	resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &class)
	if err != nil {
		return nil, fmt.Errorf(errMsgFailedGetByID, "class", id, err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return &class, nil
}

// GetClassesByName retrieves a class by its name.
func (c *Client) GetClassByName(name string) (*ResourceClass, error) {
	endpoint := fmt.Sprintf("%s/name/%s", uriClasses, name)

	var class ResourceClass
	resp, err := c.HTTP.DoRequest("GET", endpoint, nil, &class)
	if err != nil {
		return nil, fmt.Errorf(errMsgFailedGetByName, "class", name, err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return &class, nil
}

// CreateClassesByID creates a new class with the given details.
func (c *Client) CreateClass(class *ResourceClass) (*ResourceClass, error) {
	endpoint := uriClasses

	if class.Site.ID == 0 && class.Site.Name == "" {
		class.Site.ID = -1
		class.Site.Name = "none"
	}

	requestBody := struct {
		XMLName xml.Name `xml:"class"`
		*ResourceClass
	}{
		ResourceClass: class,
	}

	var createdClass ResourceClass
	resp, err := c.HTTP.DoRequest("POST", endpoint, &requestBody, &createdClass)
	if err != nil {
		return nil, fmt.Errorf(errMsgFailedCreate, "class", err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return &createdClass, nil
}

// UpdateClassByID updates an existing class with the given ID.
func (c *Client) UpdateClassByID(id int, class *ResourceClass) error {
	endpoint := fmt.Sprintf("%s/id/%d", uriClasses, id)

	requestBody := struct {
		XMLName xml.Name `xml:"class"`
		*ResourceClass
	}{
		ResourceClass: class,
	}

	_, err := c.HTTP.DoRequest("PUT", endpoint, &requestBody, nil)
	if err != nil {
		return fmt.Errorf(errMsgFailedUpdateByID, "class", id, err)
	}

	return nil
}

// UpdateClassByName updates an existing class with the given name.
func (c *Client) UpdateClassByName(name string, class *ResourceClass) error {
	endpoint := fmt.Sprintf("%s/name/%s", uriClasses, name)

	requestBody := struct {
		XMLName xml.Name `xml:"class"`
		*ResourceClass
	}{
		ResourceClass: class,
	}

	_, err := c.HTTP.DoRequest("PUT", endpoint, &requestBody, nil)
	if err != nil {
		return fmt.Errorf(errMsgFailedUpdateByName, "class", name, err)
	}

	return nil
}

// DeleteClassByID deletes an existing class with the given ID.
func (c *Client) DeleteClassByID(id int) error {
	endpoint := fmt.Sprintf("%s/id/%d", uriClasses, id)

	resp, err := c.HTTP.DoRequest("DELETE", endpoint, nil, nil)
	if err != nil {
		return fmt.Errorf(errMsgFailedDeleteByID, "class", id, err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return nil
}

// DeleteClassByName deletes a class by its name.
func (c *Client) DeleteClassByName(name string) error {
	endpoint := fmt.Sprintf("%s/name/%s", uriClasses, name)

	resp, err := c.HTTP.DoRequest("DELETE", endpoint, nil, nil)
	if err != nil {
		return fmt.Errorf(errMsgFailedDeleteByName, "class", name, err)
	}

	if resp != nil && resp.Body != nil {
		defer resp.Body.Close()
	}

	return nil
}